alamb commented on code in PR #20970: URL: https://github.com/apache/datafusion/pull/20970#discussion_r2942474353
########## docs/source/contributor-guide/development_environment.md: ########## @@ -21,7 +21,38 @@ This section describes how you can get started at developing DataFusion. -## Windows setup +## Quick Start + +For the fastest path to a working local environment, follow these steps Review Comment: I pulled most of this out of agents.md and left a link there instead ########## docs/source/contributor-guide/development_environment.md: ########## @@ -34,19 +65,19 @@ cargo build DataFusion has support for [dev containers](https://containers.dev/) which may be used for developing DataFusion in an isolated environment either locally or remote if desired. Using dev containers for developing -DataFusion is not a requirement by any means but is available for those where doing local development could be tricky +DataFusion is not a requirement but is available where doing local development could be tricky Review Comment: drive by cleanup to make this more concise ########## docs/source/contributor-guide/development_environment.md: ########## @@ -71,7 +102,7 @@ libprotoc 3.15.0 Alternatively a binary release can be downloaded from the [Release Page](https://github.com/protocolbuffers/protobuf/releases) or [built from source](https://github.com/protocolbuffers/protobuf/blob/main/src/README.md). -## Bootstrap environment +## Bootstrap Environment Review Comment: Made heading consistent. ########## 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: moved and expanded content ########## docs/source/contributor-guide/testing.md: ########## @@ -23,6 +23,39 @@ Tests are critical to ensure that DataFusion is working properly and is not accidentally broken during refactorings. All new features should have test coverage and the entire test suite is run as part of CI. +## Testing Quick Start Review Comment: THis is based on what started in AGENTS.md but I made it slightly easier to understand -- 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]
