diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8bc740303492..48d3d8ef0399 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,63 @@ ## PR Summary -## 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 - -- A development guide is available at https://matplotlib.org/devdocs/devel/index.html. +## PR Checklists -- Help with git and github is available at - https://matplotlib.org/devel/gitwash/development_workflow.html. + -- Do not create the PR out of master, but out of a separate branch. +New code: -- The PR title should summarize the changes, for example "Raise ValueError on - non-numeric input to set_xlim". Avoid non-descriptive titles such as - "Addresses issue #8576". +- [ ] 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) +- [ ] is documented, with examples if plot related -- The summary should provide at least 1-2 sentences describing the pull request - in detail (Why is this change required? What problem does it solve?) and - link to any relevant issues. +New 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 (if you have `flake8-docstrings` and `pydocstyle<4` installed, run `flake8 --docstring-convention=all` on changed files to check). + + +New features: + +- [ ] have an entry in `doc/users/next_whats_new/` (follow instructions in `doc/users/next_whats_new/README.rst`) + +API changes: + +- [ ] are documented in `doc/api/api_changes_[NEXT_VERSION]` if API changed in a backward-incompatible way (follow instructions in `doc/api/api_changes_[NEXT_VERSION]/README.rst`) + +