GH-50373: [Dev][Developer Tools] Add root AGENTS.md file#50375
Open
thisisnic wants to merge 2 commits into
Open
GH-50373: [Dev][Developer Tools] Add root AGENTS.md file#50375thisisnic wants to merge 2 commits into
thisisnic wants to merge 2 commits into
Conversation
github-actions
Bot
added
Component: Documentation
awaiting committer review
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository-root AGENTS.md to provide AI coding agents with shared, non-language-specific contribution workflow guidance for Apache Arrow.
Changes:
- Introduces
AGENTS.mdwith a high-level repository layout overview. - Documents Arrow’s issue/PR title conventions (including
GH-<id>:vsMINOR:). - Links to pre-commit usage, testing guidance, and AI-generated code policy resources.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
rok
reviewed
Jul 6, 2026
rok
left a comment
rok
left a comment
Member
There was a problem hiding this comment.
I don't have experience writing AGENTS.md files. A couple of things that I'd like agents be good at for myself:
- setting up their own dev environment and not changing mine. But sometimes I'd want to use theirs.
- building implementations (e.g. C++ and R) so they can run tests
- running banchmarks
As per my experience they can already do these tasks, they are just not always consistent about it.
| ## Pull Request Conventions | ||
|
|
||
| ### Title Format | ||
|
|
Member
There was a problem hiding this comment.
Should we link to PR template here instead? I suppose it's better for agents to have the .md file here, just noting a thought.
|
|
||
| ## Issue Conventions | ||
|
|
||
| - Prefix the issue title with the component name in brackets: |
Member
There was a problem hiding this comment.
Similar to below - should we link to our issue templates?
github-actions
Bot
added
awaiting changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rationale for this change
Help AI agents produce better PRs and conform to workflows
What changes are included in this PR?
Add AGENTS.md file at project root
Are these changes tested?
No
Are there any user-facing changes?
No