Apply suggestions from kngwyu

Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com>
This commit is contained in:
David Hewitt 2020-08-02 10:43:28 +01:00
parent 52f7429748
commit 7b36f3a44b
1 changed files with 4 additions and 4 deletions

View File

@ -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`.