Skip to content

Commit 7ba42f2

Browse files
authored
Merge pull request #26686 from story645/pr-template
PR template: shorten comment and pull up top
2 parents 9398d8a + b1e9eb7 commit 7ba42f2

File tree

1 file changed

+14
-27
lines changed

1 file changed

+14
-27
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+14-27
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
1-
## PR summary
1+
<!--
2+
Thank you so much for your PR! To help us review your contribution, please check
3+
out the development guide https://matplotlib.org/devdocs/devel/index.html
4+
-->
25

6+
## PR summary
7+
<!-- Please provide at least 1-2 sentences describing the pull request in detail
8+
(Why is this change required? What problem does it solve?) and link to relevant
9+
issues and PRs.
10+
Also please summarize the changes in the title, for example "Raise ValueError on
11+
non-numeric input to set_xlim" and avoid non-descriptive titles such as "Addresses
12+
issue #8576".
13+
-->
314
## PR checklist
415
<!-- Please mark any checkboxes that do not apply to this PR as [N/A].-->
516

@@ -9,32 +20,8 @@
920
- [ ] *New Features* and *API Changes* are noted with a [directive and release note](https://matplotlib.org/devdocs/devel/coding_guide.html#new-features-and-api-changes)
1021
- [ ] Documentation complies with [general](https://matplotlib.org/devdocs/devel/documenting_mpl.html#writing-rest-pages) and [docstring](https://matplotlib.org/devdocs/devel/documenting_mpl.html#writing-docstrings) guidelines
1122

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 https://matplotlib.org/devdocs/devel/development_workflow.html
19-
20-
- Create a separate branch for your changes and open the PR from this branch. Please avoid working on `main`.
21-
22-
- The PR title should summarize the changes, for example "Raise ValueError on
23-
non-numeric input to set_xlim". Avoid non-descriptive titles such as
24-
"Addresses issue #8576".
25-
26-
- The summary should provide at least 1-2 sentences describing the pull request
27-
in detail (Why is this change required? What problem does it solve?) and
28-
link to any relevant issues.
29-
30-
- If you are contributing fixes to docstrings, please pay attention to
31-
https://matplotlib.org/stable/devel/documenting_mpl.html#formatting-conventions. In particular,
32-
note the difference between using single backquotes, double backquotes, and
33-
asterisks in the markup.
34-
35-
We understand that PRs can sometimes be overwhelming, especially as the
23+
<!--We understand that PRs can sometimes be overwhelming, especially as the
3624
reviews start coming in. Please let us know if the reviews are unclear or
3725
the recommended next step seems overly demanding, if you would like help in
3826
addressing a reviewer's comments, or if you have been waiting too long to hear
39-
back on your PR.
40-
-->
27+
back on your PR.-->

0 commit comments

Comments
 (0)