|
2 | 2 |
|
3 | 3 | ## Developer Documentation |
4 | 4 |
|
| 5 | +- [Quick Start Setup](docs/source/contributor-guide/development_environment.md#quick-start) |
| 6 | +- [Testing Quick Start](docs/source/contributor-guide/testing.md#testing-quick-start) |
| 7 | +- [Before Submitting a PR](docs/source/contributor-guide/index.md#before-submitting-a-pr) |
5 | 8 | - [Contributor Guide](docs/source/contributor-guide/index.md) |
6 | 9 | - [Architecture Guide](docs/source/contributor-guide/architecture.md) |
7 | 10 |
|
8 | 11 | ## Before Committing |
9 | 12 |
|
10 | | -Before committing any changes, you **must** run the following checks and fix any issues: |
| 13 | +Before committing any changes, you MUST follow the instructions in |
| 14 | +[Before Submitting a PR](docs/source/contributor-guide/index.md#before-submitting-a-pr) |
| 15 | +and ensure the required checks listed there pass. Do not commit code that |
| 16 | +fails any of those checks. |
| 17 | + |
| 18 | +At a minimum, you MUST run and fix any errors from these commands before |
| 19 | +committing: |
11 | 20 |
|
12 | 21 | ```bash |
| 22 | +# Format code |
13 | 23 | cargo fmt --all |
| 24 | + |
| 25 | +# Lint (must pass with no warnings) |
14 | 26 | cargo clippy --all-targets --all-features -- -D warnings |
15 | 27 | ``` |
16 | 28 |
|
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: |
| 29 | +You can also run the full lint suite used by CI: |
25 | 30 |
|
26 | 31 | ```bash |
27 | | -cargo test --all-features |
| 32 | +./dev/rust_lint.sh |
| 33 | +# or auto-fix: ./dev/rust_lint.sh --write --allow-dirty |
28 | 34 | ``` |
29 | 35 |
|
30 | | -For SQL logic tests: |
| 36 | +When creating a PR, you MUST follow the [PR template](.github/pull_request_template.md). |
31 | 37 |
|
32 | | -```bash |
33 | | -cargo test -p datafusion-sqllogictest |
34 | | -``` |
| 38 | +## Testing |
| 39 | + |
| 40 | +See the [Testing Quick Start](docs/source/contributor-guide/testing.md#testing-quick-start) |
| 41 | +for the recommended pre-PR test commands. |
0 commit comments