GH-50373: [Dev][Developer Tools] Add root AGENTS.md file#50375
GH-50373: [Dev][Developer Tools] Add root AGENTS.md file#50375thisisnic wants to merge 5 commits into
Conversation
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
left a comment
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.
|
Can we instead suggest that PRs should never be opened automatically by AI? Instead have the human review changes locally and write a proper description themselves? |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| | Directory | Description | | ||
| |-----------|-------------| | ||
| | `cpp/` | Core C++ library (libarrow, Parquet, Flight, Gandiva, etc.) | | ||
| | `python/` | PyArrow (Python bindings for libarrow) | | ||
| | `r/` | R package | | ||
| | `c_glib/` | C/GLib bindings | | ||
| | `ruby/` | Ruby bindings | | ||
| | `matlab/` | MATLAB implementation | | ||
| | `docs/` | Sphinx documentation source | | ||
| | `ci/` | CI configuration (Docker, scripts) | | ||
| | `dev/` | Developer tools and release scripts | | ||
| | `format/` | Arrow columnar format specification | | ||
| | `testing/` | Shared test data (integration testing) | | ||
|
|
| pre-commit run -a # all hooks | ||
| pre-commit run --all-files <hook-alias> # e.g. python, cpp (see aliases in .pre-commit-config.yaml) |
I think "never" might be a little strong here, e.g. I find it useful to have Claude open PRs for me (though only when I tell it) when I understand the change but would find it hard to describe in words or do a worse job of it; example: #50488 How about we adopt the convention that Airflow uses:
This would allows us to differentiate between things which have been checked/reviewed by humans or not. You could also submit a PR to update the AI guidance, generally and for new contributors specifically as well? |
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