Skip to content

Commit 1a50874

Browse files
authored
Merge pull request #9473 from jklymak/prtemplate
Changes to better highlight development-workflow in docs
2 parents afe9384 + 128399c commit 1a50874

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!--Thank you so much for your PR! To help us review, fill out the form
22
to the best of your ability. Please make use of the development guide at
3-
https://matplotlib.org/devdocs/devel/index.html-->
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. -->
48

59
<!--Provide a general summary of your changes in the title above, for
610
example "Raises ValueError on Non-Numeric Input to set_xlim". Please avoid
711
non-descriptive titles such as "Addresses issue #8576".-->
812

9-
<!--If you are able to do so, please do not create the
10-
PR out of master, but out of a separate branch. See
11-
https://matplotlib.org/devel/gitwash/development_workflow.html for
12-
instructions.-->
1313

1414
## PR Summary
1515

@@ -21,7 +21,7 @@ detail. Why is this change required? What problem does it solve?-->
2121
## PR Checklist
2222

2323
- [ ] Has Pytest style unit tests
24-
- [ ] Code is PEP 8 compliant
24+
- [ ] Code is PEP 8 compliant
2525
- [ ] New features are documented, with examples if plot related
2626
- [ ] Documentation is sphinx and numpydoc compliant
2727
- [ ] Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)

doc/devel/contributing.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,12 @@ How to contribute
168168

169169
The preferred way to contribute to Matplotlib is to fork the `main
170170
repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
171-
then submit a "pull request" (PR):
171+
then submit a "pull request" (PR).
172+
173+
The best practices for using GitHub to make PRs to Matplotlib are
174+
documented in the :ref:`development-workflow` section.
175+
176+
A brief overview is:
172177

173178
1. `Create an account <https://github.com/join>`_ on
174179
GitHub if you do not already have one.

0 commit comments

Comments
 (0)