diff options
| author | orSolocate <38433858+orSolocate@users.noreply.github.com> | 2022-02-02 09:42:06 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-02 08:42:06 +0100 |
| commit | 7e1eec27925f19f10934f5f4426de047c9b02597 (patch) | |
| tree | 4a6fbb88517407555e8be9d4d7cdc81b91a110ea /doc/development_guide | |
| parent | 2d560189f1e2050ce022ec48981cce1f7a88b4d9 (diff) | |
| download | pylint-git-7e1eec27925f19f10934f5f4426de047c9b02597.tar.gz | |
Add pip install -e to docs before testing (#5687)
Diffstat (limited to 'doc/development_guide')
| -rw-r--r-- | doc/development_guide/testing.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/development_guide/testing.rst b/doc/development_guide/testing.rst index 85d1043ef..c75293d27 100644 --- a/doc/development_guide/testing.rst +++ b/doc/development_guide/testing.rst @@ -12,6 +12,14 @@ Test your code! Pylint is very well tested and has a high code coverage. New contributions are not accepted unless they include tests. + +Before you start testing your code, you need to install your source-code package locally. +To set up your environment for testing, open a terminal outside of your forked repository and run: + + pip install -e <forked_repo_dir_name> + +This ensures your testing environment is similar to Pylint's testing environment on GitHub. + Pylint uses two types of tests: unittests and functional tests. - The unittests can be found in the ``/pylint/test`` directory and they can |