From 17bc9fea78adb8e1034cdad99a1fbb5af405e761 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 16:59:30 -0400 Subject: [PATCH 1/9] Create PULL_REQUEST_TEMPLATE.md Started template for PR --- .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..4bd8948803ee --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ +Thank you so much for your PR! To help us review, please make use of our +[development guide](http://matplotlib.org/devel/index.html) and fill out the form to the best of your ability. + +**PR Summary** + +- Please provide at least 1-2 sentences describing the pull request. +- What type of PR is this? + - [ ] library bug fix + - [ ] documentation bug fix + - [ ] new documentation + - [ ] new feature + - [ ] other + +**[PR Checklist](http://matplotlib.org/devel/coding_guide.html#pull-request-checklist)** +- [ ] Code is [tested](http://matplotlib.org/devel/testing.html#testing) using[Py.test](https://docs.pytest.org/en/latest/) style tests) on Py2 and Py3 +- [ ] Code is [PEP 8](https://www.python.org/dev/peps/pep-0008/) compliant +- [ ] New features are documented-and have an example if plot related +- [ ] Documentation is [sphinx](http://matplotlib.org/devdocs/devel/documenting_mpl.html) and [numpydoc](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt) compliant +- [ ] Related issues and pull requests [are listed](https://help.github.com/articles/autolinked-references-and-urls/) + +** Major Changes ** +- [ ] non-trivial: made an entry in the [CHANGELOG](https://github.com/matplotlib/matplotlib/blob/master/doc/users/prev_whats_new/changelog.rst). +- [ ] major new feature: added an entry to [doc/users/whats_new.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new). +- [ ] change the API in a backward-incompatible way: documented it in [doc/api/api_changes.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/api/api_changes) + +We understand that PRs can sometimes feel like a guantlet, especially as the reviews start coming in. Please let us know +if the reviews are unclear or the recommended next step is too ardous, and if you'd like help in addressing a reveiwers +comments. And ping us if you've been waiting too long to hear back on your PR! From 90096e0898451022ab7ef570311618d8aa7a993e Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 17:06:51 -0400 Subject: [PATCH 2/9] Update PULL_REQUEST_TEMPLATE.md removed changelog 'cause @tacaswell said to --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4bd8948803ee..6a722a368225 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,6 @@ Thank you so much for your PR! To help us review, please make use of our - [ ] Related issues and pull requests [are listed](https://help.github.com/articles/autolinked-references-and-urls/) ** Major Changes ** -- [ ] non-trivial: made an entry in the [CHANGELOG](https://github.com/matplotlib/matplotlib/blob/master/doc/users/prev_whats_new/changelog.rst). - [ ] major new feature: added an entry to [doc/users/whats_new.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new). - [ ] change the API in a backward-incompatible way: documented it in [doc/api/api_changes.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/api/api_changes) From 5a96eff60d3e6dd21dba8ae8b33371f8770a37d5 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 17:11:45 -0400 Subject: [PATCH 3/9] Update PULL_REQUEST_TEMPLATE.md relative links for the mpl internal references --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6a722a368225..722ef12a852f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,8 +19,8 @@ Thank you so much for your PR! To help us review, please make use of our - [ ] Related issues and pull requests [are listed](https://help.github.com/articles/autolinked-references-and-urls/) ** Major Changes ** -- [ ] major new feature: added an entry to [doc/users/whats_new.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new). -- [ ] change the API in a backward-incompatible way: documented it in [doc/api/api_changes.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/api/api_changes) +- [ ] major new feature: added an entry to [doc/users/whats_new.rst](../doc/users/whats_new). +- [ ] change the API in a backward-incompatible way: documented it in [doc/api/api_changes.rst](../doc/api/api_changes) We understand that PRs can sometimes feel like a guantlet, especially as the reviews start coming in. Please let us know if the reviews are unclear or the recommended next step is too ardous, and if you'd like help in addressing a reveiwers From f155f56e5b42dd2c9b28517ede8199b7b798f606 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 17:28:06 -0400 Subject: [PATCH 4/9] point to devdocs instead of devel --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 722ef12a852f..05b4dcaff87d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ Thank you so much for your PR! To help us review, please make use of our -[development guide](http://matplotlib.org/devel/index.html) and fill out the form to the best of your ability. +[development guide](http://matplotlib.org/devdocs/devel/coding_guide.html#documentation) and fill out the form to the best of your ability. **PR Summary** From 341767f406c776dd5f40bded8e15f1a8cb487aef Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 17:53:12 -0400 Subject: [PATCH 5/9] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 05b4dcaff87d..a9379830f04c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,9 @@ Thank you so much for your PR! To help us review, please make use of our [development guide](http://matplotlib.org/devdocs/devel/coding_guide.html#documentation) and fill out the form to the best of your ability. **PR Summary** +- Please use a title that describes the bug being fixed or the feature being implemented-for example "Raises ValueError on Non-Numeric Input to set_xlim" +- Please provide at least 1-2 sentences describing the pull request in detail. -- Please provide at least 1-2 sentences describing the pull request. - What type of PR is this? - [ ] library bug fix - [ ] documentation bug fix @@ -23,5 +24,4 @@ Thank you so much for your PR! To help us review, please make use of our - [ ] change the API in a backward-incompatible way: documented it in [doc/api/api_changes.rst](../doc/api/api_changes) We understand that PRs can sometimes feel like a guantlet, especially as the reviews start coming in. Please let us know -if the reviews are unclear or the recommended next step is too ardous, and if you'd like help in addressing a reveiwers -comments. And ping us if you've been waiting too long to hear back on your PR! +if the reviews are unclear or the recommended next step is overwhelming, or if you would like help in addressing a reviewer's comments. And please ping us if you've been waiting too long to hear back on your PR! From 408d78ba58879886024d746188436247a18568cb Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 18:07:51 -0400 Subject: [PATCH 6/9] shortened, moved to comments, removed links --- .github/PULL_REQUEST_TEMPLATE.md | 34 +++++++++++++------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a9379830f04c..73949a180e1f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,27 +1,21 @@ -Thank you so much for your PR! To help us review, please make use of our -[development guide](http://matplotlib.org/devdocs/devel/coding_guide.html#documentation) and fill out the form to the best of your ability. +Thank you so much for your PR! To help us review, fill out the form to the best of your ability. Also, please make use of the development guide at http://matplotlib.org/devdocs/devel/index.html -**PR Summary** -- Please use a title that describes the bug being fixed or the feature being implemented-for example "Raises ValueError on Non-Numeric Input to set_xlim" -- Please provide at least 1-2 sentences describing the pull request in detail. + -- What type of PR is this? - - [ ] library bug fix - - [ ] documentation bug fix - - [ ] new documentation - - [ ] new feature - - [ ] other +## PR Summary + -**[PR Checklist](http://matplotlib.org/devel/coding_guide.html#pull-request-checklist)** -- [ ] Code is [tested](http://matplotlib.org/devel/testing.html#testing) using[Py.test](https://docs.pytest.org/en/latest/) style tests) on Py2 and Py3 -- [ ] Code is [PEP 8](https://www.python.org/dev/peps/pep-0008/) compliant -- [ ] New features are documented-and have an example if plot related -- [ ] Documentation is [sphinx](http://matplotlib.org/devdocs/devel/documenting_mpl.html) and [numpydoc](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt) compliant -- [ ] Related issues and pull requests [are listed](https://help.github.com/articles/autolinked-references-and-urls/) +## Motivation and Context + + -** Major Changes ** -- [ ] major new feature: added an entry to [doc/users/whats_new.rst](../doc/users/whats_new). -- [ ] change the API in a backward-incompatible way: documented it in [doc/api/api_changes.rst](../doc/api/api_changes) +## PR Checklist +- [ ] Code is tested using Py.test on Py2 and Py3 +- [ ] Code is PEP 8 compliant +- [ ] New features are documented-and have an example if plot related +- [ ] Documentation is sphinx and numpydoc compliant +- [ ] major new feature: added an entry to doc/users/whats_new.rst +- [ ] change the API in a backward-incompatible way: documented it in doc/api/api_changes.rst We understand that PRs can sometimes feel like a guantlet, especially as the reviews start coming in. Please let us know if the reviews are unclear or the recommended next step is overwhelming, or if you would like help in addressing a reviewer's comments. And please ping us if you've been waiting too long to hear back on your PR! From aabe383a8d84af862e305e0ac5eedd03da9eb445 Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 18:10:06 -0400 Subject: [PATCH 7/9] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 73949a180e1f..5cd2fcb553e5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,10 +3,7 @@ Thank you so much for your PR! To help us review, fill out the form to the best ## PR Summary - - -## Motivation and Context - + ## PR Checklist From adbc03ffda1743bcc39b015586bc3b49617ae4fb Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 19:24:32 -0400 Subject: [PATCH 8/9] language tidying --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5cd2fcb553e5..dcb12c3de026 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,12 +7,12 @@ Thank you so much for your PR! To help us review, fill out the form to the best ## PR Checklist -- [ ] Code is tested using Py.test on Py2 and Py3 +- [ ] Has Pytest style unit tests - [ ] Code is PEP 8 compliant -- [ ] New features are documented-and have an example if plot related +- [ ] New features are documented, with examples if plot related - [ ] Documentation is sphinx and numpydoc compliant -- [ ] major new feature: added an entry to doc/users/whats_new.rst -- [ ] change the API in a backward-incompatible way: documented it in doc/api/api_changes.rst +- [ ] Added an entry to doc/users/whats_new.rst if major new feature: +- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way -We understand that PRs can sometimes feel like a guantlet, especially as the reviews start coming in. Please let us know -if the reviews are unclear or the recommended next step is overwhelming, or if you would like help in addressing a reviewer's comments. And please ping us if you've been waiting too long to hear back on your PR! +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 , or if you would like help in addressing a reviewer's comments. And please ping us if you've been waiting too long to hear back on your PR! From 4bf429b09c2e212fea7f9fb2fc5abdd2c6368a0d Mon Sep 17 00:00:00 2001 From: hannah Date: Thu, 13 Apr 2017 20:01:24 -0400 Subject: [PATCH 9/9] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dcb12c3de026..1d154428712b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,7 +11,7 @@ Thank you so much for your PR! To help us review, fill out the form to the best - [ ] Code is PEP 8 compliant - [ ] New features are documented, with examples if plot related - [ ] Documentation is sphinx and numpydoc compliant -- [ ] Added an entry to doc/users/whats_new.rst if major new feature: +- [ ] Added an entry to doc/users/whats_new.rst if major new feature - [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way We understand that PRs can sometimes be overwhelming, especially as the reviews start coming in. Please let us know