2010YOUY01 commented on code in PR #20970: URL: https://github.com/apache/datafusion/pull/20970#discussion_r2957624522
########## docs/source/contributor-guide/index.md: ########## @@ -99,6 +101,19 @@ If you are concerned that a larger design will be lost in a string of small PRs, Note all commits in a PR are squashed when merged to the `main` branch so there is one commit per PR after merge. +## Before Submitting a PR + +Before submitting a PR, run the standard formatting and lint checks and fix any +issues they report: + +```bash +./ci/scripts/rust_fmt.sh +./ci/scripts/rust_clippy.sh Review Comment: ```suggestion ./dev/rust_lint.sh # use the `--write` flag to automatically fix some formatting and lint errors # ./dev/rust_lint.sh --write --allow-dirty ``` This script is the entry point for all non-functional tests. It includes the previous two scripts as well as several others. ########## docs/source/contributor-guide/testing.md: ########## @@ -23,6 +23,38 @@ 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 + +While developing a feature or bug fix, best practice is to run the smallest set +of tests that gives confidence for your change, then expand as needed. + +Initially, run the tests in the crates you changed. For example, if you made changes +to files in `datafusion-optimizer/src`, run the corresponding crate tests: + +```shell +cargo test -p datafusion-optimizer +``` + +Then, run the `sqllogictest` suite, which is the main regression suite for SQL +behavior and covers most DataFusion features. Review Comment: ```suggestion Then, run the `sqllogictest` suite, which provides a strong speed–coverage tradeoff for development: it runs quickly while offering broad regression coverage across most SQL behavior in DataFusion. ``` -- 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]
