Skip to content

Commit 17bc9fe

Browse files
authored
Create PULL_REQUEST_TEMPLATE.md
Started template for PR
1 parent 8e796b3 commit 17bc9fe

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Thank you so much for your PR! To help us review, please make use of our
2+
[development guide](http://matplotlib.org/devel/index.html) and fill out the form to the best of your ability.
3+
4+
**PR Summary**
5+
6+
- Please provide at least 1-2 sentences describing the pull request.
7+
- What type of PR is this?
8+
- [ ] library bug fix
9+
- [ ] documentation bug fix
10+
- [ ] new documentation
11+
- [ ] new feature
12+
- [ ] other
13+
14+
**[PR Checklist](http://matplotlib.org/devel/coding_guide.html#pull-request-checklist)**
15+
- [ ] 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
16+
- [ ] Code is [PEP 8](https://www.python.org/dev/peps/pep-0008/) compliant
17+
- [ ] New features are documented-and have an example if plot related
18+
- [ ] 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
19+
- [ ] Related issues and pull requests [are listed](https://help.github.com/articles/autolinked-references-and-urls/)
20+
21+
** Major Changes **
22+
- [ ] non-trivial: made an entry in the [CHANGELOG](https://github.com/matplotlib/matplotlib/blob/master/doc/users/prev_whats_new/changelog.rst).
23+
- [ ] major new feature: added an entry to [doc/users/whats_new.rst](https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new).
24+
- [ ] 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)
25+
26+
We understand that PRs can sometimes feel like a guantlet, especially as the reviews start coming in. Please let us know
27+
if the reviews are unclear or the recommended next step is too ardous, and if you'd like help in addressing a reveiwers
28+
comments. And ping us if you've been waiting too long to hear back on your PR!

0 commit comments

Comments
 (0)