From 055b20c56da04d86614444056e76514412266cbe Mon Sep 17 00:00:00 2001 From: Bruno Beltran Date: Wed, 15 Apr 2020 15:05:12 -0700 Subject: [PATCH 1/8] DOCS: include how to reproduce CI in PR template --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8bc740303492..01c559e275de 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,7 +13,8 @@ Thank you so much for your PR! To help us review your contribution, please consider the following points: -- A development guide is available at https://matplotlib.org/devdocs/devel/index.html. +- A development guide is available at + https://matplotlib.org/devdocs/devel/index.html. - Help with git and github is available at https://matplotlib.org/devel/gitwash/development_workflow.html. From 57ab76b35cfd09ba0acced22021f347efb314b15 Mon Sep 17 00:00:00 2001 From: Bruno Beltran Date: Thu, 16 Apr 2020 04:18:30 -0700 Subject: [PATCH 2/8] DOCS: @timhoffm's PR template suggestions --- .github/PULL_REQUEST_TEMPLATE.md | 64 +++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 21 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 01c559e275de..bc6c932dd2c5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,63 @@ ## PR Summary -## PR Checklist + - + +For new code: + +- [ ] Has Pytest style unit tests (and `pytest lib/matplotlib/tests` passes) +- [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check) +- [ ] New code is documented, with examples if plot related + +For new documentation: + +- [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error) +- [ ] New documentation conforms to matplotlib style conventions. (If you have `flake8-docstrings` and `pydocstyle<4` installed, run `flake8 --docstring-convention=all` on changed files to check). + +For new features: + +- [ ] Added an entry to `doc/users/next_whats_new/` if major new feature (follow instructions in `README.rst` there) + +For API changes: + +- [ ] Documented in `doc/api/api_changes_[VERSION]` if API changed in a backward-incompatible way (follow instructions in `README.rst` there) + + ## PR Checklists - + -For new code: +New code: - [ ] Has Pytest style unit tests (and `pytest lib/matplotlib/tests` passes) - [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check) -- [ ] New code is documented, with examples if plot related +- [ ] Code is documented, with examples if plot related -For new documentation: +New documentation: - [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error) -- [ ] New documentation conforms to matplotlib style conventions. (If you have `flake8-docstrings` and `pydocstyle<4` installed, run `flake8 --docstring-convention=all` on changed files to check). - -For new features: +- [ ] Documentation conforms to matplotlib style conventions. (If you have `flake8-docstrings` and `pydocstyle<4` installed, run `flake8 --docstring-convention=all` on changed files to check). -- [ ] Added an entry to `doc/users/next_whats_new/` if major new feature (follow instructions in `README.rst` there) +New features: -For API changes: +- [ ] Added an entry to `doc/users/next_whats_new/` if major new feature (follow instructions in `doc/users/next_whats_new/README.rst`) -- [ ] Documented in `doc/api/api_changes_[VERSION]` if API changed in a backward-incompatible way (follow instructions in `README.rst` there) +API changes: - New features: @@ -28,20 +34,16 @@ API changes: - [ ] 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`) + @@ -53,8 +53,8 @@ If you have further questions: https://matplotlib.org/devel/gitwash/development_workflow.html. We understand that PRs can sometimes be overwhelming, especially as the -reviews start coming in. Please let us know if the reviews are unclear or -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 +reviews start coming in. Please let us know if the reviews are unclear, +the recommended next step seems overly demanding, you would like help in +addressing a reviewer's comments, or you have been waiting too long to hear back on your PR. --> From 55a001204b6a7b2f56258ba935bb127c58eafa41 Mon Sep 17 00:00:00 2001 From: Bruno Beltran Date: Fri, 24 Apr 2020 15:00:09 -0700 Subject: [PATCH 7/8] DOCS: pr template grammar and visual organization --- .github/PULL_REQUEST_TEMPLATE.md | 41 +++++++++++++++++--------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 627f2192f3bb..79868577225c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,24 +1,36 @@ ## PR Summary - ## PR Checklists New code: -- [ ] Has Pytest style unit tests (and `pytest lib/matplotlib/tests` passes) -- [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check) -- [ ] Code is documented, with examples if plot related +- [ ] has Pytest style unit tests (and `pytest lib/matplotlib/tests` passes) +- [ ] is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check) +- [ ] is documented, with examples if plot related New documentation: -- [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error) -- [ ] Documentation conforms to matplotlib style conventions. (If you have `flake8-docstrings` and `pydocstyle<4` installed, run `flake8 --docstring-convention=all` on changed files to check). +- [ ] 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). +- [ ] 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`) @@ -52,7 +52,7 @@ If you have further questions: - A more complete development guide is available at https://matplotlib.org/devdocs/devel/index.html. -- Help with git and github is available at +- Help with Git and GitHub is available at https://matplotlib.org/devel/gitwash/development_workflow.html. We understand that PRs can sometimes be overwhelming, especially as the