Skip to content

MNT: Simplify PR template #32100

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.

Sign up for GitHub

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

Open
timhoffm wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −31
Open

MNT: Simplify PR template #32100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 6 additions & 31 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,14 @@
<!--
Thank you so much for your PR! To help us review your contribution, please check
out the development guide https://matplotlib.org/devdocs/devel/index.html
-->
<!-- Thank you for your PR! Please check our development guide https://matplotlib.org/devdocs/devel/index.html -->

@story645 story645 Jul 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- Thank you for your PR! Please check our development guide https://matplotlib.org/devdocs/devel/index.html -->
<!-- Thank you for your PR! Please check that your PR complies with our development guide https://matplotlib.org/devdocs/devel/index.html -->


## PR summary
<!-- Please describe the pull request, using the questions below as guidance, and link to any relevant issues and PRs:
<!-- Please describe what problem is solved and why you chose this solution. -->

@story645 story645 Jul 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- Please describe what problem is solved and why you chose this solution. -->
<!-- Please describe what issue is resolved and why you chose this solution. -->

If they are solving an issue then hopefully it's a prompt to link that issue, and means the same thing even if there's no underlying issue.


- Why is this change necessary?
- What problem does it solve?
- What is the reasoning for this implementation?
Comment on lines -9 to -11

@story645 story645 Jul 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can this language maybe get moved to https://matplotlib.org/devdocs/devel/contribute.html#first-contributions b/c that's what it was aimed for

@timhoffm timhoffm Jul 22, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, oh that section has a verbatim copy of the PR template - will also need and upate, but not today anymore.

@story645 story645 Jul 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, oh that section has a verbatim copy of the PR template - will also need and upate, but not today anymore.

That dropdown is an include to this file specifically so that they're always in sync:

matplotlib/doc/devel/contribute.rst

Lines 328 to 332 in 102a1d2

.. dropdown:: `Pull request template <https://github.com/matplotlib/matplotlib/blob/main/.github/PULL_REQUEST_TEMPLATE.md>`_
:open:
.. literalinclude:: ../../.github/PULL_REQUEST_TEMPLATE.md
:language: markdown

Additionally, please summarize the changes in the title, for example "Raise ValueError on
non-numeric input to set_xlim" and avoid non-descriptive titles such as "Addresses
issue #8576".
If possible, please provide a minimum self-contained example.
-->

## AI Disclosure
<!-- Please tell us whether you used AI in writing this PR, and if so briefly describe how.
Read our policy at
https://matplotlib.org/devdocs/devel/contribute.html#use-of-generative-ai
-->
<!-- Please describe if and how AI is used. See also our AI policy: https://matplotlib.org/devdocs/devel/contribute.html#use-of-generative-ai -->

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

- [ ] "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)
- [ ] new and changed code is [tested](https://matplotlib.org/devdocs/devel/testing.html)
- [ ] *Plotting related* features are demonstrated in an [example](https://matplotlib.org/devdocs/devel/document.html#write-examples-and-tutorials)
- [ ] *New Features* and *API Changes* are noted with a [directive and release note](https://matplotlib.org/devdocs/devel/api_changes.html#announce-changes-deprecations-and-new-features)
- [ ] Documentation complies with [general](https://matplotlib.org/devdocs/devel/document.html#write-rest-pages) and [docstring](https://matplotlib.org/devdocs/devel/document.html#write-docstrings) guidelines
## PR quality check
<!-- Make sure to conform with the project standards. Please check the following box! -->

@story645 story645 Jul 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don' t think this needs the free text explanation of the checkbox

Suggested change
<!-- Make sure to conform with the project standards. Please check the following box! -->

@timhoffm timhoffm Jul 22, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without explanation and with the shorted checkbox text, will users still understand that they should tick the box?

@story645 story645 Jul 22, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the folks who aren't checking just aren't checking, but you can also make it sound like an attestation?

- [ ] I affirm that this PR complies with [matplotlib pull request guidelines](https://matplotlib.org/devdocs/devel/pr_guide.html#pull-request-guidelines)


<!--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
back on your PR.-->
- [ ] I am aware of and have followed the [matplotlib pull request guidelines](https://matplotlib.org/devdocs/devel/pr_guide.html#pull-request-guidelines)

@story645 story645 Jul 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] I am aware of and have followed the [matplotlib pull request guidelines](https://matplotlib.org/devdocs/devel/pr_guide.html#pull-request-guidelines)
- [ ] this PR complies with [matplotlib pull request guidelines](https://matplotlib.org/devdocs/devel/pr_guide.html#pull-request-guidelines)

Loading