floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add pre-commit to CONTRIBUTING.txt

This commit is contained in:
Ronny Pfannschmidt 2018-05-18 09:37:24 +02:00
parent 3b9e063fe8
commit b60376dc28
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.rst
View File

@ -163,6 +163,7 @@ Short version
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
#. Fork the repository; #. Fork the repository;
#. enable and install pre-commit https://pre-commit.com/ to ensure styleguides and codechecks are followed
#. Target ``master`` for bugfixes and doc changes; #. Target ``master`` for bugfixes and doc changes;
#. Target ``features`` for new features or functionality changes. #. Target ``features`` for new features or functionality changes.
#. Follow **PEP-8**. There's a ``tox`` command to help fixing it: ``tox -e fix-lint``. #. Follow **PEP-8**. There's a ``tox`` command to help fixing it: ``tox -e fix-lint``.
@ -216,6 +217,16 @@ Here is a simple overview, with pytest-specific bits:
If you need some help with Git, follow this quick start If you need some help with Git, follow this quick start
guide: https://git.wiki.kernel.org/index.php/QuickStart guide: https://git.wiki.kernel.org/index.php/QuickStart
#. install pre-commit and install its hook on the pytest repo
https://pre-commit.com/ is a framework for managing and maintaining multi-language pre-commit hooks
pytest uses pre-commit to ensure code-style and code formatting is the same
$ pip install --user pre-commit
$ pre-commit install
Afterwards pre-commit will run whenever you commit.
#. Install tox #. Install tox
Tox is used to run all the tests and will automatically setup virtualenvs Tox is used to run all the tests and will automatically setup virtualenvs