From 38a29085286f8a027c9ed439afd7b98c2c98f121 Mon Sep 17 00:00:00 2001 From: Philip Allgaier Date: Tue, 16 Mar 2021 18:53:33 +0100 Subject: [PATCH] Note about PR and tox requirements (#772) * Note about PR and tox requirements As confirmed by Paulus: https://discord.com/channels/330944238910963714/330990195199442944/798321546673389618 * Update docs/development_testing.md Co-authored-by: Tom Brien Co-authored-by: Tom Brien --- docs/development_testing.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/development_testing.md b/docs/development_testing.md index fffe409a..cb004544 100644 --- a/docs/development_testing.md +++ b/docs/development_testing.md @@ -18,7 +18,13 @@ It might be required that you install additional packages depending on your dist - Fedora: `sudo dnf -y install systemd-devel gcc-c++` - Ubuntu: `sudo apt-get install libudev-dev` -**Important:** Run `tox` before you create your pull request to avoid annoying fixes. +:::info Important +Run `tox` before you create your pull request to avoid annoying fixes. +::: + +:::note +Running the full `tox` test suite will take quite some time, so as the minimal requirement for pull requests, run at least the tests that are related to your code changes (see details below on how to). The full test suite will anyway be run by the CI once you created your pull request and before it can be merged. +::: Running `tox` will run unit tests against the locally available Python releases, as well as validate the code and document style using `pycodestyle`, `pydocstyle` and `pylint`. You can run tests on only one `tox` target -- just use `-e` to select an environment. For example, `tox -e lint` runs the linters only, and `tox -e py38` runs unit tests only on Python 3.8.