Skip to content

Commit 3fde5d5

Browse files
committed
Cleanup issue template.
1. Move all the comment text to the bottom of the template. This allows one to fill in the relevant fields without having to look for them through a wall of text. 2. Reword the comments in a slightly more compact/concise manner (I believe we can maintain a friendly tone without repeating "please" 9 times in 15 sentences).
1 parent 1928c38 commit 3fde5d5

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+30-27
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,5 @@
1-
<!--Thank you so much for your PR! To help us review, fill out the form
2-
to the best of your ability. Please make use of the development guide at
3-
https://matplotlib.org/devdocs/devel/index.html
4-
5-
For help with git and github workflow, please see https://matplotlib.org/devel/gitwash/development_workflow.html
6-
7-
Please do not create the PR out of master, but out of a separate branch. -->
8-
9-
<!--Provide a general summary of your changes in the title above, for
10-
example "Raises ValueError on Non-Numeric Input to set_xlim". Please avoid
11-
non-descriptive titles such as "Addresses issue #8576".-->
12-
13-
<!--If you are contributing fixes to docstrings, please pay attention to
14-
http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular,
15-
note the difference between using single backquotes, double backquotes, and
16-
asterisks in the markup.-->
17-
181
## PR Summary
192

20-
<!--Please provide at least 1-2 sentences describing the pull request in
21-
detail. Why is this change required? What problem does it solve?-->
22-
23-
<!--If it fixes an open issue, please link to the issue here.-->
24-
253
## PR Checklist
264

275
- [ ] Has Pytest style unit tests
@@ -31,8 +9,33 @@ detail. Why is this change required? What problem does it solve?-->
319
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
3210
- [ ] Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way
3311

34-
<!--We understand that PRs can sometimes be overwhelming, especially as the
35-
reviews start coming in. Please let us know if the reviews are unclear or the
36-
recommended next step seems overly demanding , or if you would like help in
37-
addressing a reviewer's comments. And please ping us if you've been waiting
38-
too long to hear back on your PR.-->
12+
<!--
13+
Thank you so much for your PR! To help us review your contribution, please
14+
consider the following points:
15+
16+
- A development guide is available at https://matplotlib.org/devdocs/devel/index.html.
17+
18+
- Help with git and github is available at
19+
https://matplotlib.org/devel/gitwash/development_workflow.html.
20+
21+
- Do not create the PR out of master, but out of a separate branch.
22+
23+
- The PR title should summarize the changes, for example "Raise ValueError on
24+
non-numeric input to set_xlim". Avoid non-descriptive titles such as
25+
"Addresses issue #8576".
26+
27+
- The summary should provide at least 1-2 sentences describing the pull request
28+
in detail (Why is this change required? What problem does it solve?) and
29+
link to any relevant issues.
30+
31+
- If you are contributing fixes to docstrings, please pay attention to
32+
http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular,
33+
note the difference between using single backquotes, double backquotes, and
34+
asterisks in the markup.
35+
36+
We understand that PRs can sometimes be overwhelming, especially as the
37+
reviews start coming in. Please let us know if the reviews are unclear or
38+
the recommended next step seems overly demanding, if you would like help in
39+
addressing a reviewer's comments, or if you have been waiting too long to hear
40+
back on your PR.
41+
-->

0 commit comments

Comments
 (0)