exercism/python
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Updared pre-commit checklist as per issue 2700.

Browse Source
This commit is contained in:
BethanyG
2021-11-09 07:25:03 -08:00
committed by BethanyG
parent b47809622e
commit 76c216f43a
1 changed files with 23 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@@ -84,16 +84,31 @@ When in doubt, 📛 [ Open an issue ][open-an-issue]📛 . We wil
<details>
<summary>⚠️&nbsp;&nbsp;<b><em>Pre-Commit Checklist</em></b>&nbsp;⚠️</summary>
<br>
<table>
<td>
<br>
1. &nbsp;Run [`configlet-lint`][configlet-lint] if the track [config.json](config-json) has been modified.
2. &nbsp;Run [Prettier][prettier] on all markdown files.
- (_Optionally_) run [yapf][yapf] ([_config file_][.style.yapf]) to help format your code, and give you a head start on making the linters happy.
3. &nbsp;Run [flake8][flake8] ([_config file_][.flake8]) & [pylint][pylint] ([_config file_][pylintrc]) to ensure all Python code files conform to general code style standards.
4. &nbsp;Run `test/check-exercises.py [EXERCISE]` to check if your test changes function correctly.
5. &nbsp;Run the `example.py` or `exemplar.py` file against the exercise test file to ensure that it passes without error.
6. &nbsp;If you modified or created a `hints.md` file for a practice exercise, [regenerate](#generating-practice-exercise-documents) it.
- [ ] &nbsp;Update & rebase your branch with any (recent) upstream changes.
- [ ] &nbsp;Spell and grammar check all prose changes.
- [ ] &nbsp;Run [Prettier](https://prettier.io/) on all markdown and JSON files.
- (_Optionally_) run [yapf](https://github.com/google/yapf) ([_yapf config_](https://github.com/exercism/python/blob/main/.style.yapf)) to help format your code.
- [ ] &nbsp;Run [flake8](http://flake8.pycqa.org/) with [_flake8 config_](https://github.com/exercism/python/blob/main/.flake8) to check general code style standards.
- [ ] &nbsp; Run [pylint](https://pylint.pycqa.org/en/v2.11.1/user_guide/index.html) with [_pylint config_](https://github.com/exercism/python/blob/main/pylintrc) to check extended code style standards.
- [ ] &nbsp;Use pytest or the [python-track-test-runner](https://github.com/exercism/python-test-runner) to test any changed `example.py`/`exemplar.py`files
&nbsp;against their associated test files.
- [ ] &nbsp;Similarly, use [pytest](https://docs.pytest.org/en/6.2.x/contents.html) or
the [python-track-test-runner](https://github.com/exercism/python-test-runner) to test any changed _**test**_ files.
- Check that tests **fail** properly, as well as succeed.
&nbsp;(_**e.g.**, make some tests fail on purpose to "test the tests" & failure messages_).
- [ ] &nbsp;Double-check all files for proper EOL.
- [ ] &nbsp;[Regenerate](https://github.com/exercism/python/blob/main/CONTRIBUTING.md#generating-practice-exercise-documents) exercise documents when you modified or created a `hints.md` file for a practice exercise.
- [ ] &nbsp;[Regenerate the test file](https://github.com/exercism/python/blob/main/CONTRIBUTING.md#auto-generated-test-files-and-test-templates) if you modified or created a `JinJa2` template file for a practice exercise.
- Run the generated test file result against its `example.py`.
- [ ] &nbsp;Run [`configlet-lint`](https://github.com/exercism/configlet#configlet-lint) if the track [config.json](https://github.com/exercism/docs/blob/main/building/tracks/config-json.md), or any other exercise `config.json` has been modified.
</details>
</td>
</table>
</details>
<br>
<img align="left" width="90" height="80" src="https://github.com/exercism/website-icons/blob/main/exercism/logo-big-bordered.png">