DOCS: add links and sections to PR template

brunobeltran · brunobeltran · commit e827dd921e83 · 2020-08-24T16:51:19.000-07:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,12 +2,22 @@
 
 ## 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
+<!-- Please remove any checkboxes that do not apply to this PR. -->
+
+Code:
+- [ ] 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](https://matplotlib.org/devel/documenting_mpl.html#writing-examples-and-tutorials) if plot related.
+- [ ] have an entry in `doc/users/next_whats_new/` (follow instructions in [the "What's New" README](https://github.com/matplotlib/matplotlib/blob/master/doc/users/next_whats_new/README.rst)).
+
+API Changes:
+- [ ] are documented in `doc/api/next_api_changes/` (follow instructions in [the API changes README.rst](https://github.com/matplotlib/matplotlib/blob/master/doc/api/next_api_changes/README.rst).
+
+Documentation:
+- [ ] is [sphinx](https://www.sphinx-doc.org/en/master/index.html) and [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) 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`, then run `flake8 --docstring-convention=all`).
 
 <!--
 Thank you so much for your PR!  To help us review your contribution, please
@@ -39,3 +49,4 @@ the recommended next step seems overly demanding, if you would like help in
 addressing a reviewer's comments, or if you have been waiting too long to hear
 back on your PR.
 -->
+
