Skip to content

Commit afaf7b2

Browse files
committed
Add repository guidelines for Codex Agents
1 parent 9f60343 commit afaf7b2

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

AGENTS.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Repository Guidelines for Codex Agents
2+
3+
This repository uses Rust and contains documentation written in Markdown and TOML configuration files. When modifying code or docs, please follow these steps before committing:
4+
5+
1. **Run the Rust lints**
6+
```bash
7+
./dev/rust_lint.sh
8+
```
9+
This script checks formatting (`cargo fmt`), lints (`cargo clippy`), validates `taplo` formatting and generates docs with warnings enabled.
10+
11+
2. **Format Markdown and TOML**
12+
```bash
13+
# Format Markdown files
14+
prettier -w {datafusion,datafusion-cli,datafusion-examples,dev,docs}/**/*.md
15+
16+
# Check TOML formatting
17+
taplo format --check
18+
```
19+
20+
3. **Run the tests**
21+
```bash
22+
cargo test
23+
```
24+
You may also use `cargo nextest run` if installed.
25+
26+
4. **Optional: build documentation**
27+
```bash
28+
./docs/build.sh
29+
```
30+
This renders the user and contributor guides.
31+
32+
Ensure these commands succeed before creating commits.

0 commit comments

Comments
 (0)