This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 9b7d0924bc Add AGENTS.md / CLAUDE.md (#20939)
9b7d0924bc is described below
commit 9b7d0924bcd3fd92824704903937a5945bf0d62f
Author: Daniël Heres <[email protected]>
AuthorDate: Sat Mar 14 18:45:31 2026 +0100
Add AGENTS.md / CLAUDE.md (#20939)
## Which issue does this PR close?
Closes: #20941
## Rationale for this change
Given that AI tools are used more and more, start with some `AGENTS.md`
and `CLAUDE.md` that simply point to the Contributor Guide /
Architecture Guide.
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->
---------
Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
---
AGENTS.md | 34 ++++++++++++++++++++++++++++++++++
CLAUDE.md | 1 +
2 files changed, 35 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000000..eeedbd8bc4
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,34 @@
+# Agent Guidelines for Apache DataFusion
+
+## Developer Documentation
+
+- [Contributor Guide](docs/source/contributor-guide/index.md)
+- [Architecture Guide](docs/source/contributor-guide/architecture.md)
+
+## Before Committing
+
+Before committing any changes, you **must** run the following checks and fix
any issues:
+
+```bash
+cargo fmt --all
+cargo clippy --all-targets --all-features -- -D warnings
+```
+
+- `cargo fmt` ensures consistent code formatting across the project.
+- `cargo clippy` catches common mistakes and enforces idiomatic Rust patterns.
All warnings must be resolved (treated as errors via `-D warnings`).
+
+Do not commit code that fails either of these checks.
+
+## Testing
+
+Run relevant tests before submitting changes:
+
+```bash
+cargo test --all-features
+```
+
+For SQL logic tests:
+
+```bash
+cargo test -p datafusion-sqllogictest
+```
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
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
