-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOCS: include how to reproduce CI in PR template #17153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
brunobeltran
wants to merge
8
commits into
matplotlib:master
from
brunobeltran:pr-template-improvements
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
055b20c
DOCS: include how to reproduce CI in PR template
brunobeltran 57ab76b
DOCS: @timhoffm's PR template suggestions
brunobeltran ff1a393
DOCS: @story645's PR template suggestions
brunobeltran 9498a34
DOCS: don't show non-checkbox items in PR template
brunobeltran a94c061
DOCS: whats_new not just for "major feature"s
brunobeltran 73fedf0
mild copy edits
story645 55a0012
DOCS: pr template grammar and visual organization
brunobeltran b2c6070
DOCS: @QuLogic's PR template suggestions
brunobeltran File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,63 @@ | ||
## PR Summary | ||
|
||
## PR Checklist | ||
|
||
- [ ] Has Pytest style unit tests | ||
- [ ] Code is [Flake 8](http://flake8.pycqa.org/en/latest/) compliant | ||
- [ ] New features are documented, with examples if plot related | ||
- [ ] Documentation is sphinx and numpydoc compliant | ||
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there) | ||
- [ ] Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way | ||
|
||
<!-- | ||
Thank you so much for your PR! To help us review your contribution, please | ||
consider the following points: | ||
Thank you so much for your PR! Please summarize the purpose of the PR here | ||
using at least 1-2 sentences. | ||
brunobeltran marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
To help us review your pull request, make sure: | ||
|
||
- The PR title descriptively summarizes the changes. | ||
- e.g. "Raise `ValueError` on non-numeric input to `set_xlim`" | ||
- Please don't use non-descriptive titles such as "Addresses issue #8576". | ||
- The PR summary includes: | ||
- How the PR implements any changes. | ||
- Why these changes are necessary. | ||
- The PR is not out of master, but out of a separate branch. | ||
- e.g. `your-user-name:non-numeric-xlim -> matplotlib:master` | ||
- Optional: PR cross-links related issues. | ||
--> | ||
|
||
- A development guide is available at https://matplotlib.org/devdocs/devel/index.html. | ||
## PR Checklists | ||
|
||
- Help with git and github is available at | ||
https://matplotlib.org/devel/gitwash/development_workflow.html. | ||
<!-- Feel free to delete any checkboxes that do not apply to this PR. --> | ||
|
||
- Do not create the PR out of master, but out of a separate branch. | ||
New code: | ||
|
||
- The PR title should summarize the changes, for example "Raise ValueError on | ||
non-numeric input to set_xlim". Avoid non-descriptive titles such as | ||
"Addresses issue #8576". | ||
- [ ] has pytest style unit tests (and `pytest` passes) | ||
- [ ] is [Flake 8](https://flake8.pycqa.org/en/latest/) compliant (run `flake8` on changed files to check) | ||
- [ ] is documented, with examples if plot related | ||
|
||
- The summary should provide at least 1-2 sentences describing the pull request | ||
in detail (Why is this change required? What problem does it solve?) and | ||
link to any relevant issues. | ||
New documentation: | ||
|
||
- [ ] is Sphinx and numpydoc compliant (the docs should [build](https://matplotlib.org/devel/documenting_mpl.html#building-the-docs) without error) | ||
- [ ] conforms to Matplotlib style conventions (if you have `flake8-docstrings` and `pydocstyle<4` installed, run `flake8 --docstring-convention=all` on changed files to check). | ||
<!-- | ||
- If you are contributing fixes to docstrings, please pay attention to | ||
http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular, | ||
https://matplotlib.org/devel/documenting_mpl.html#formatting. In particular, | ||
note the difference between using single backquotes, double backquotes, and | ||
asterisks in the markup. | ||
--> | ||
|
||
New features: | ||
|
||
- [ ] have an entry in `doc/users/next_whats_new/` (follow instructions in `doc/users/next_whats_new/README.rst`) | ||
|
||
API changes: | ||
|
||
- [ ] are documented in `doc/api/api_changes_[NEXT_VERSION]` if API changed in a backward-incompatible way (follow instructions in `doc/api/api_changes_[NEXT_VERSION]/README.rst`) | ||
|
||
<!-- | ||
brunobeltran marked this conversation as resolved.
Show resolved
Hide resolved
|
||
If you have further questions: | ||
|
||
- A more complete development guide is available at | ||
https://matplotlib.org/devdocs/devel/index.html. | ||
|
||
- Help with Git and GitHub is available at | ||
https://matplotlib.org/devel/gitwash/development_workflow.html. | ||
|
||
We understand that PRs can sometimes be overwhelming, especially as the | ||
reviews start coming in. Please let us know if the reviews are unclear or | ||
the recommended next step seems overly demanding, if you would like help in | ||
addressing a reviewer's comments, or if you have been waiting too long to hear | ||
reviews start coming in. Please let us know if the reviews are unclear, | ||
the recommended next step seems overly demanding, you would like help in | ||
addressing a reviewer's comments, or you have been waiting too long to hear | ||
back on your PR. | ||
--> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.