Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e9a545c

Browse files
committed
Condensed checklist by linking out to the related section of the
contributing guide and removed stuff about building/passing tests since that's handled in the CI. Hoping that shortening it will improve usage of it. Also swapped out the gitwash link for the developement guide.
1 parent 558f111 commit e9a545c

1 file changed

Lines changed: 9 additions & 17 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
1-
## PR Summary
1+
## PR summary
22

3-
## PR Checklist
3+
## PR checklist
4+
<!-- Please mark any checkboxes that do not apply to this PR as [N/A].-->
45

5-
<!-- Please mark any checkboxes that do not apply to this PR as [N/A]. -->
6-
**Linked Issue**
7-
- [ ] Added "closes #0000" in the PR description to link it to the original issue.
8-
9-
**Documentation and Tests**
10-
- [ ] Has pytest style unit tests (and `pytest` passes)
11-
- [ ] Documentation is sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error).
12-
- [ ] New plotting related features are documented with examples.
13-
14-
**Release Notes**
15-
- [ ] New features are marked with a `.. versionadded::` directive in the docstring and documented in `doc/users/next_whats_new/`
16-
- [ ] API changes are marked with a `.. versionchanged::` directive in the docstring and documented in `doc/api/next_api_changes/`
17-
- [ ] Release notes conform with instructions in `next_whats_new/README.rst` or `next_api_changes/README.rst`
6+
- [ ] "closes #0000" is in the body of the PR description to [link the related issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
7+
- [ ] new and changed code is [tested](https://matplotlib.org/devdocs/devel/testing.html)
8+
- [ ] *Plotting related* features are demonstrated in an [example](https://matplotlib.org/devdocs/devel/documenting_mpl.html#writing-examples-and-tutorials)
9+
- [ ] *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)
10+
- [ ] 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
1811

1912
<!--
2013
Thank you so much for your PR! To help us review your contribution, please
2114
consider the following points:
2215
2316
- A development guide is available at https://matplotlib.org/devdocs/devel/index.html.
2417
25-
- Help with git and github is available at
26-
https://matplotlib.org/devel/gitwash/development_workflow.html.
18+
- Help with git and github is available at https://matplotlib.org/devdocs/devel/development_workflow.html
2719
2820
- Create a separate branch for your changes and open the PR from this branch. Please avoid working on `main`.
2921

0 commit comments

Comments
 (0)