|
1 | 1 | ## PR Summary |
2 | 2 |
|
3 | | -## PR Checklist |
| 3 | +<!-- |
| 4 | +Thank you so much for your PR! To help us review your contribution, please |
| 5 | +summarize the purpose of this PR here. |
| 6 | +
|
| 7 | +- The summary should provide at least 1-2 sentences describing the pull request |
| 8 | + in detail (Why is this change required? What problem does it solve?) and |
| 9 | + link to any relevant issues. |
| 10 | +--> |
| 11 | + |
| 12 | + |
| 13 | +## PR Checklists |
| 14 | + |
| 15 | +<!-- Feel free to delete any checklists that do not apply to this PR --> |
| 16 | + |
| 17 | +For new code: |
4 | 18 |
|
5 | 19 | - [ ] Has Pytest style unit tests (and `pytest lib/matplotlib/tests` passes) |
6 | | -- [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant (run |
7 | | - `flake8` on changed files to check) |
8 | | -- [ ] New features (if any) are documented, with examples if plot related |
9 | | -- [ ] Documentation is sphinx and numpydoc compliant (the docs should |
10 | | - [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) |
11 | | - without error) |
12 | | -- [ ] New documentation conforms to matplotlib style conventions. (If you have |
13 | | - `flake8-docstrings` and `pydocstyle<4` installed, run |
14 | | - `flake8 --docstring-convention=all` on changed files to check). |
15 | | -- [ ] Added an entry to doc/users/next\_whats\_new/ if major new feature |
16 | | - (follow instructions in README.rst there) |
17 | | -- [ ] Documented in doc/api/api\_changes\_[VERSION] if API changed in a |
18 | | - backward-incompatible way (follow instructions in README.rst there) |
| 20 | +- [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check) |
| 21 | +- [ ] New code is documented, with examples if plot related |
19 | 22 |
|
20 | | -<!-- |
21 | | -Thank you so much for your PR! To help us review your contribution, please |
22 | | -consider the following points: |
| 23 | +For new documentation: |
23 | 24 |
|
24 | | -- A development guide is available at |
25 | | - https://matplotlib.org/devdocs/devel/index.html. |
| 25 | +- [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error) |
| 26 | +- [ ] 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). |
26 | 27 |
|
27 | | -- Help with git and github is available at |
28 | | - https://matplotlib.org/devel/gitwash/development_workflow.html. |
| 28 | +For new features: |
| 29 | + |
| 30 | +- [ ] Added an entry to `doc/users/next_whats_new/` if major new feature (follow instructions in `README.rst` there) |
| 31 | + |
| 32 | +For API changes: |
| 33 | + |
| 34 | +- [ ] Documented in `doc/api/api_changes_[VERSION]` if API changed in a backward-incompatible way (follow instructions in `README.rst` there) |
| 35 | + |
| 36 | +<!-- |
| 37 | +A few other common gotchas: |
29 | 38 |
|
30 | 39 | - Do not create the PR out of master, but out of a separate branch. |
31 | 40 |
|
32 | 41 | - The PR title should summarize the changes, for example "Raise ValueError on |
33 | | - non-numeric input to set_xlim". Avoid non-descriptive titles such as |
| 42 | + non-numeric input to set_xlim". Avoid non-descriptive titles such as |
34 | 43 | "Addresses issue #8576". |
35 | 44 |
|
36 | | -- The summary should provide at least 1-2 sentences describing the pull request |
37 | | - in detail (Why is this change required? What problem does it solve?) and |
38 | | - link to any relevant issues. |
39 | | -
|
40 | 45 | - If you are contributing fixes to docstrings, please pay attention to |
41 | | - http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular, |
| 46 | + http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular, |
42 | 47 | note the difference between using single backquotes, double backquotes, and |
43 | 48 | asterisks in the markup. |
44 | 49 |
|
| 50 | +
|
| 51 | +If you have further questions: |
| 52 | +
|
| 53 | +- A more complete development guide is available at |
| 54 | + https://matplotlib.org/devdocs/devel/index.html. |
| 55 | +
|
| 56 | +- Help with git and github is available at |
| 57 | + https://matplotlib.org/devel/gitwash/development_workflow.html. |
| 58 | +
|
45 | 59 | We understand that PRs can sometimes be overwhelming, especially as the |
46 | | -reviews start coming in. Please let us know if the reviews are unclear or |
| 60 | +reviews start coming in. Please let us know if the reviews are unclear or |
47 | 61 | the recommended next step seems overly demanding, if you would like help in |
48 | 62 | addressing a reviewer's comments, or if you have been waiting too long to hear |
49 | 63 | back on your PR. |
|
0 commit comments