jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-19 15:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Note about PR and tox requirements (#772)

Browse Source 
* 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 <TomBrien@users.noreply.github.com>

Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>
This commit is contained in:
Philip Allgaier 2021-03-16 18:53:33 +01:00 committed by GitHub
parent 560495c9c3
commit 38a2908528
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/development_testing.md
View File

@ -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++` - Fedora: `sudo dnf -y install systemd-devel gcc-c++`
- Ubuntu: `sudo apt-get install libudev-dev` - 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. 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.