diff options
| author | Steve Piercy <web@stevepiercy.com> | 2022-08-12 06:26:51 -0700 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2022-08-12 06:26:51 -0700 |
| commit | bdbb8c408566f1a4009d7a8dd32f72719c1f3849 (patch) | |
| tree | 544d1b4ea2c7e40b79fb91f96f4d848743129f2e /HACKING.txt | |
| parent | 4d963930e03e26f6b831eae81ee93f2aa8271ff7 (diff) | |
| parent | 1e439035e41da3767acbcae79689fb05dfdeb317 (diff) | |
| download | pyramid-bdbb8c408566f1a4009d7a8dd32f72719c1f3849.tar.gz pyramid-bdbb8c408566f1a4009d7a8dd32f72719c1f3849.tar.bz2 pyramid-bdbb8c408566f1a4009d7a8dd32f72719c1f3849.zip | |
Merge branch 'master' of https://github.com/Pylons/pyramid
Diffstat (limited to 'HACKING.txt')
| -rw-r--r-- | HACKING.txt | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/HACKING.txt b/HACKING.txt index b9cdcc940..9cc2e8edb 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -50,7 +50,7 @@ In order to add a feature to Pyramid: - The feature must be documented in both the API and narrative documentation (in `docs/`). -- The feature must work fully on the following CPython versions: 3.6, 3.7, 3.8, and 3.9 on both UNIX and Windows. +- The feature must work fully on the following CPython versions: 3.7, 3.8, 3.9, and 3.10 on both UNIX and Windows. - The feature must work on the latest version of PyPy3. @@ -69,6 +69,12 @@ Coding Style $ $TOX -e format +- Pyramid uses flake8 (https://pypi.org/project/flake8/) to enforce PEP8 style guidelines. + To run flake8, as well as running checks for Black and isort: + + $ $TOX -e lint + +Black, isort, and flake8 versions are pinned for stability and reproducibility. Running Tests ------------- @@ -80,9 +86,9 @@ Running Tests $ $TOX -e py - To run `tox` for Python 3.9 explicitly, you may use: + To run `tox` for Python 3.10 explicitly, you may use: - $ $TOX -e py39 + $ $TOX -e py310 - To run individual tests (i.e., during development), you can use `pytest` syntax as follows, where `$VENV` is an environment variable set to the path @@ -103,7 +109,7 @@ Test Coverage ------------- - The codebase *must* have 100% test statement coverage after each commit. You - can test coverage via `tox -e py39`. + can test coverage via `tox -e py310`. Documentation Coverage and Building HTML Documentation |