diff options
author | Bruno Oliveira <nicoddemus@gmail.com> | 2019-11-20 20:26:45 -0300 |
---|---|---|
committer | Bruno Oliveira <bruno@esss.com.br> | 2019-11-21 10:06:32 -0300 |
commit | 8f2fd8ffc039f45a8daaedd62e6a2ca9af2542f6 (patch) | |
tree | 6be08930346edd4f5d161261c39a381a33c4765b /CONTRIBUTING.rst | |
parent | 58ec5bea353ba7141781b683d811824fd7b9a31b (diff) | |
download | pytest-8f2fd8ffc039f45a8daaedd62e6a2ca9af2542f6.tar.gz |
Add develop instructions to CONTRIBUTING
From: https://github.com/pytest-dev/pytest/pull/6244
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8e59191ab..a3ae731e4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -262,6 +262,19 @@ Here is a simple overview, with pytest-specific bits: When committing, ``pre-commit`` will re-format the files if necessary. +#. If instead of using ``tox`` you prefer to run the tests directly, then we suggest to create a virtual environment and use + an editable install with the ``testing`` extra:: + + $ python3 -m venv .venv + $ source .venv/bin/activate # Linux + $ .venv/Scripts/activate.bat # Windows + $ pip install -e ".[testing]" + + Afterwards, you can edit the files and run pytest normally:: + + $ pytest testing/test_config.py + + #. Commit and push once your tests pass and you are happy with your change(s):: $ git commit -a -m "<commit message>" |