Skip to content

Apache DataFusion SQL Query Engine

Add AGENTS.md / CLAUDE.md (#20939)

Daniël Heres9b7d0924bcd3
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