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

Skip to content

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
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 47 additions & 25 deletions .github/PULL_REQUEST_TEMPLATE.md
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.

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`)

<!--
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.
-->