This is an automated email from the ASF dual-hosted git repository.
github-merge-queue[bot] pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 412dfa590c docs: add agent contribution guide (#11400)
412dfa590c is described below
commit 412dfa590c4659573bf57d77f3f712fb77d9df2e
Author: Phoenix <[email protected]>
AuthorDate: Fri Oct 9 05:41:34 2026 +0000
docs: add agent contribution guide (#11400)
# Which issue does this PR close?
- Closes #11049
# Rationale for this change
Coding agents need a short entry point to existing contribution guidance
so they can follow the repository's setup, validation, and submission
expectations.
# What changes are included in this PR?
- Add a root `AGENTS.md` linking to the contributor guide, crate
READMEs, PR template, and relevant CI workflows.
- Include essential local checks and summarize guidance for benchmarks,
Miri, API changes, and AI-assisted contributions.
- Symlink `CLAUDE.md` to `AGENTS.md`.
AI assistance was used to draft the guide; the contributor reviewed it.
# Are these changes tested?
No automated tests were added because this change only adds contributor
documentation. Local links, heading anchors, whitespace, and spelling
were checked.
# Are there any significant user-facing changes?
No.
---
AGENTS.md | 43 +++++++++++++++++++++++++++++++++++++++
CLAUDE.md | 1 +
dev/release/rat_exclude_files.txt | 2 ++
3 files changed, 46 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000000..ad18eb6734
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,43 @@
+# Agent Guidelines for Apache Arrow-rs
+
+This file is an entry point. Follow the detailed guidance in
+[CONTRIBUTING.md](CONTRIBUTING.md) and the documentation for the crates you
change.
+
+## Developer Documentation
+
+- [Repository overview and crate list](README.md#repository-structure)
+- Crate READMEs: [Arrow](arrow/README.md), [Parquet](parquet/README.md),
+ [Arrow Flight](arrow-flight/README.md), and the README for each affected
crate
+- [Contributor guide](CONTRIBUTING.md)
+- [Pull request template](.github/pull_request_template.md)
+
+## Setup and Validation
+
+Initialize test data before running tests or examples:
+
+```bash
+git submodule update --init
+```
+
+Run the checks relevant to your change from the repository root:
+
+```bash
+# Check Rust formatting and lints for code changes
+cargo +stable fmt --all -- --check
+cargo clippy --workspace --all-targets --all-features -- -D warnings
+
+# Check spelling, including documentation changes
+# If typos is not installed, run: cargo install typos-cli
+typos --config typos.toml
+
+# Run the full workspace test suite for code changes
+cargo test --workspace
+```
+
+See the [testing](CONTRIBUTING.md#running-the-tests),
[formatting](CONTRIBUTING.md#code-formatting),
[Clippy](CONTRIBUTING.md#clippy-lints), and
[spelling](CONTRIBUTING.md#spell-checking) guidance for details.
+
+## Additional Checks
+
+For performance work, see
[benchmarks](CONTRIBUTING.md#performance-improvements). For memory-safety
checks, see [Miri](CONTRIBUTING.md#miri).
+For public API changes, see [breaking
changes](CONTRIBUTING.md#breaking-changes).
+
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 120000
index 0000000000..47dc3e3d86
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1 @@
+AGENTS.md
\ No newline at end of file
diff --git a/dev/release/rat_exclude_files.txt
b/dev/release/rat_exclude_files.txt
index d08a0ea8c7..b5dc0f5599 100644
--- a/dev/release/rat_exclude_files.txt
+++ b/dev/release/rat_exclude_files.txt
@@ -11,6 +11,8 @@ parquet_derive/test/dependency/*
.gitattributes
**.gitignore
.gitmodules
+AGENTS.md
+CLAUDE.md
Cargo.lock
filtered_rat.txt
rat.txt
