Dandandan commented on code in PR #20970: URL: https://github.com/apache/datafusion/pull/20970#discussion_r2944322744
########## AGENTS.md: ########## @@ -2,33 +2,18 @@ ## Developer Documentation +- [Quick Start Setup](docs/source/contributor-guide/development_environment.md#quick-start) +- [Testing Quick Start](docs/source/contributor-guide/testing.md#testing-quick-start) +- [Before Submitting a PR](docs/source/contributor-guide/index.md#before-submitting-a-pr) - [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. +See [Before Submitting a PR](docs/source/contributor-guide/index.md#before-submitting-a-pr) Review Comment: My experience is agents *will* read the .md file on start, but will not always go read all the materials linked - still helps because they are found by `grep` etc. tools. So to make sure they read things like `cargo fmt` you'll have to put it in the AGENTS.md -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
