Skip to content

Commit 9b7d092

Browse files
Dandandanclaude
andauthored
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) <noreply@anthropic.com>
1 parent 6d3a846 commit 9b7d092

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Agent Guidelines for Apache DataFusion
2+
3+
## Developer Documentation
4+
5+
- [Contributor Guide](docs/source/contributor-guide/index.md)
6+
- [Architecture Guide](docs/source/contributor-guide/architecture.md)
7+
8+
## Before Committing
9+
10+
Before committing any changes, you **must** run the following checks and fix any issues:
11+
12+
```bash
13+
cargo fmt --all
14+
cargo clippy --all-targets --all-features -- -D warnings
15+
```
16+
17+
- `cargo fmt` ensures consistent code formatting across the project.
18+
- `cargo clippy` catches common mistakes and enforces idiomatic Rust patterns. All warnings must be resolved (treated as errors via `-D warnings`).
19+
20+
Do not commit code that fails either of these checks.
21+
22+
## Testing
23+
24+
Run relevant tests before submitting changes:
25+
26+
```bash
27+
cargo test --all-features
28+
```
29+
30+
For SQL logic tests:
31+
32+
```bash
33+
cargo test -p datafusion-sqllogictest
34+
```

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)