diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8bc740303492..ccc8eb320e54 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,12 +2,15 @@ ## PR Checklist -- [ ] Has Pytest style unit tests -- [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant -- [ ] New features are documented, with examples if plot related -- [ ] Documentation is sphinx and numpydoc compliant -- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there) -- [ ] Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way + + +- [ ] Has pytest style unit tests (and `pytest` passes). +- [ ] Is [Flake 8](https://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check). +- [ ] New features are documented, with examples if plot related. +- [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error). +- [ ] Conforms to Matplotlib style conventions (install `flake8-docstrings` and `pydocstyle<4` and run `flake8 --docstring-convention=all`). +- [ ] New features have an entry in `doc/users/next_whats_new/` (follow instructions in README.rst there). +- [ ] API changes documented in `doc/api/next_api_changes/` (follow instructions in README.rst there).