diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2d33ce35..19f06e7d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,11 +5,11 @@ Please consider adding the following to your pull request: - docs to all new functions and / or detail in the guide - tests for all new or changed functions -Be aware our the CI pipeline will check your pull request for the following: - - Rust tests (`cargo test`) - - Rust lints (`cargo clippy --all -- -Dwarnings`) +Be aware the CI pipeline will check your pull request for the following: + - Rust tests (Just `cargo test` or `make test` if you need to test examples) + - Rust lints (`make clippy`) - Rust formatting (`cargo fmt`) - - Python formatting (`black --check`. You can install black with `pip install black`) + - Python formatting (`black . --check`. You can install black with `pip install black`) - Compatibility with all supported Python versions for all examples. This uses `tox`; you can do run it using `make test_py`. You can run a similar set of checks as the CI pipeline using `make test`.