You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@orc.apache.org by "dongjoon-hyun (via GitHub)" <gi...@apache.org> on 2026/03/23 21:40:18 UTC
[PR] ORC-2143: Add AGENTS.md for AI coding assistants [orc]
dongjoon-hyun opened a new pull request, #2593:
URL: https://github.com/apache/orc/pull/2593
### What changes were proposed in this pull request?
This PR introduces an `AGENTS.md` file at the root of the repository. `AGENTS.md` is a dedicated documentation file intended to guide AI coding assistants (such as GitHub Copilot, Cursor, Gemini, etc.) when they are used by contributors.
It provides AI agents with essential project context, including:
- The separation of C++ (`c++/`) and Java (`java/`) modules
- Accurate build and testing commands (CMake / Maven wrap)
- Issue tracking conventions (requiring JIRA `ORC-XXXX`, `dev/create_orc_jira.py`
- Recommended local multi-environment testing strategy [docker/run-all.sh] and personal fork GitHub Actions tests.
### Why are the changes needed?
As more developers use AI-assisted tools for coding, these tools often lack repository-specific context, leading to incorrect assumptions (e.g., suggesting raw `mvn` instead of `./mvnw`, or standard CMake instead of `make test-out`). This guideline will significantly improve the quality, accuracy, and compliance of the code and commands generated by AI agents for both new and existing contributors.
### How was this patch tested?
Manual review.
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: `Gemini 3.1 Pro (High)` on `Antigravity`.
--
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: issues-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] ORC-2143: Add `AGENTS.md` for AI coding assistants [orc]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #2593:
URL: https://github.com/apache/orc/pull/2593#discussion_r2985919041
##########
AGENTS.md:
##########
@@ -0,0 +1,62 @@
+# AI Agent Guidelines for Apache ORC
Review Comment:
Thank you for review. We don't need for obvious cases like `README.md`, @wgtmac .
--
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: issues-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] ORC-2143: Add `AGENTS.md` for AI coding assistants [orc]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun closed pull request #2593: ORC-2143: Add `AGENTS.md` for AI coding assistants
URL: https://github.com/apache/orc/pull/2593
--
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: issues-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] ORC-2143: Add `AGENTS.md` for AI coding assistants [orc]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on PR #2593:
URL: https://github.com/apache/orc/pull/2593#issuecomment-4113916766
Merged to main.
--
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: issues-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] ORC-2143: Add `AGENTS.md` for AI coding assistants [orc]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on PR #2593:
URL: https://github.com/apache/orc/pull/2593#issuecomment-4113918544
Merged to main
--
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: issues-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] ORC-2143: Add `AGENTS.md` for AI coding assistants [orc]
Posted by "wgtmac (via GitHub)" <gi...@apache.org>.
wgtmac commented on code in PR #2593:
URL: https://github.com/apache/orc/pull/2593#discussion_r2978519096
##########
AGENTS.md:
##########
@@ -0,0 +1,62 @@
+# AI Agent Guidelines for Apache ORC
Review Comment:
Just curious: for documents like this, do we need to add ASF license header?
--
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: issues-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org