From 52f7429748051b66ce117ab3bfed46944f7bbc6c Mon Sep 17 00:00:00 2001 From: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Date: Sun, 2 Aug 2020 01:09:52 +0100 Subject: [PATCH 1/2] Update PR template --- .github/pull_request_template.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a2377f97..2d33ce35 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,15 @@ Thank you for contributing to pyo3! -Here are some things you should check for submitting your pull request: +Please consider adding the following to your pull request: + - an entry in CHANGELOG.md + - docs to all new functions and / or detail in the guide + - tests for all new or changed functions - - Run `cargo fmt` (This is checked by travis ci) - - Run `cargo clippy` and check there are no hard errors (There are a bunch of existing warnings; This is also checked by travis) - - If applicable, add an entry in the changelog. - - If applicable, add documentation to all new items and extend the guide. - - If applicable, add tests for all new or fixed functions - - If you changed any python code, run `black .`. You can install black with `pip install black`) +Be aware our the CI pipeline will check your pull request for the following: + - Rust tests (`cargo test`) + - Rust lints (`cargo clippy --all -- -Dwarnings`) + - Rust formatting (`cargo fmt`) + - 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 might want to run `tox` (`pip install tox`) locally to check compatibility with all supported python versions. If you're using linux or mac you might find the Makefile helpful for testing. +You can run a similar set of checks as the CI pipeline using `make test`. From 7b36f3a44b5780f02a279d94ccd96dfc7d7c4794 Mon Sep 17 00:00:00 2001 From: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Date: Sun, 2 Aug 2020 10:43:28 +0100 Subject: [PATCH 2/2] Apply suggestions from kngwyu Co-authored-by: Yuji Kanagawa --- .github/pull_request_template.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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`.