You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "Jens-G (via GitHub)" <gi...@apache.org> on 2026/03/27 09:39:14 UTC
[PR] Add AGENTS.md with AI contribution guidelines for the project [thrift]
Jens-G opened a new pull request, #3367:
URL: https://github.com/apache/thrift/pull/3367
Covers ASF legal/licensing compliance, JIRA+GitHub issue tracking, PR conventions (THRIFT-NNNN prefix, squash, affected Client languages), AI-generated content labelling (Co-Authored-By/Generated-by), and language-specific rule hierarchy across /lib, /test, /tutorial. CLAUDE.md is a thin wrapper that imports AGENTS.md via @-syntax so Claude Code users and other AI tools (e.g. OpenAI Codex) both work.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add AGENTS.md with AI contribution guidelines for the project [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G commented on PR #3367:
URL: https://github.com/apache/thrift/pull/3367#issuecomment-6220288563
Much simpler. The intention was to do "make style" where it already exists and where it gets added in the future. ☺️
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add AGENTS.md with AI contribution guidelines for the project [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G merged PR #3367:
URL: https://github.com/apache/thrift/pull/3367
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add AGENTS.md with AI contribution guidelines for the project [thrift]
Posted by "kpumuk (via GitHub)" <gi...@apache.org>.
kpumuk commented on code in PR #3367:
URL: https://github.com/apache/thrift/pull/3367#discussion_r4289163470
##########
AGENTS.md:
##########
@@ -0,0 +1,97 @@
+# Apache Thrift — AI Contribution Guidelines
+
+This file governs AI-assisted work on the Apache Thrift codebase.
+It supplements but does **not** replace [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+---
+
+## 1. ASF Legal Compliance (Third-Party Code)
+
+Apache Thrift is an [Apache Software Foundation (ASF)](https://www.apache.org/) project released under the **Apache License 2.0**.
+The AI **must** actively enforce and monitor ASF licensing policy:
+
+- **Proactively flag conflicts**: Before introducing any dependency, snippet, or code derived from an external source, verify its license is compatible with Apache 2.0.
+ Incompatible licenses include (non-exhaustive): GPL, AGPL, SSPL, BUSL, CC-BY-NC.
+ Compatible examples: MIT, BSD-2/3, Apache 2.0, ISC, MPL 2.0 (with caveats).
+- **Category X / Category A**: Follow the [ASF Third-Party Licensing Policy](https://www.apache.org/legal/resolved.html).
+ Category A licenses may be included; Category X licenses must **never** be introduced.
+- **Update `LICENSE` and `NOTICE`**: When adding third-party code or binaries that require attribution, add the appropriate notices to `LICENSE` and/or `NOTICE` following the [ASF guide on licenses and notices](https://www.apache.org/dev/licensing-howto.html).
+ If in doubt whether an entry is required, **add it and flag it in the PR description** for committer review.
+- **Generative AI output**: The [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) applies. Be aware that AI-generated code may unintentionally reproduce copyrighted material. Flag any non-trivial generated blocks in commit messages or PR descriptions.
+
+---
+
+## 2. Issue Tracking
+
+| Type | Tracker | Notes |
+|---|---|---|
+| Significant changes | [Apache JIRA — THRIFT project](https://issues.apache.org/jira/browse/THRIFT) | Required for all non-trivial PRs |
+| Minor / quick fixes | GitHub Issues | Typos, trivial compiler warnings, etc. |
+
+**JIRA integration with GitHub**: Including a JIRA ticket identifier at the start of a PR title automatically creates a link from JIRA to the PR.
+
+- PR title format: `THRIFT-9999: Short description of the change`
+- Commit message format (required for code changes):
+ ```
+ THRIFT-9999: Short description of the change
+ Client: cpp,py,java (comma-separated list of affected languages)
+ ```
+
+Example: [THRIFT-5929](https://issues.apache.org/jira/projects/THRIFT/issues/THRIFT-5929) → [PR #3350](https://github.com/apache/thrift/pull/3350).
+
+---
+
+## 3. Pull Request Requirements
+
+Follow [`CONTRIBUTING.md`](CONTRIBUTING.md) in full. Key points:
+
+- One commit per issue (squash before submitting).
+- All significant changes need a JIRA ticket.
+- Provide tests for every submitted change.
+- Verify coding standards: `make style`.
Review Comment:
This makes `make style` mandatory for agents, but not all languages provide this target... Was your intention to hook up rubocop/black/biome and such to `make style`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org