Skip to content
Merged
Prev Previous commit
Next Next commit
shortened, moved to comments, removed links
  • Loading branch information
story645 authored Apr 13, 2017
commit 408d78ba58879886024d746188436247a18568cb
34 changes: 14 additions & 20 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.
<!--- Provide a general summary of your changes in the Title above, for example "Raises ValueError on Non-Numeric Input to set_xlim". Please avoid non-descriptive titles such as "Addresses issue #8576"-->

- What type of PR is this?
- [ ] library bug fix
- [ ] documentation bug fix
- [ ] new documentation
- [ ] new feature
- [ ] other
## PR Summary
<!--- Please provide at least 1-2 sentences describing the pull request in detail. Also indicate the type of PR: bug fix or new feature, and documentation or code. -->

**[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
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

** 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's pytest (no dot) these days

it's may be a bit harsh to request testing on both py2 and py3 (plus you also need to check somewhat antique versions of numpy) so I'd just say "unit tests are present" (travis will catch failures anyways) (for example I typically only run tests on py3.6+latest numpy and just let travis tell me if anything else needs to be corrected)

- [ ] Code is PEP 8 compliant
- [ ] New features are documented-and have an example if plot related
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra dash

- [ ] Documentation is sphinx and numpydoc compliant
- [ ] major new feature: added an entry to doc/users/whats_new.rst
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"For major new features", and below "For backwards incompatible changes to the API"

- [ ] 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gauntlet

the line wrapping is a bit weird.

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!