GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Split PR guide into two (for authors and for maintainers) by melissawm · Pull Request #32588 · matplotlib/matplotlib

Conversation

@melissawm

@melissawm melissawm commented Nov 10, 2026

Copy link
Copy Markdown
Member

PR summary

The current PR guide is very long and has instructions for authors mixed in with reviewer guidelines. This PR splits the PR guide into two different pages: one guide for PR authors, one for PR reviewers.

Content has been split into two but not really changed, except for reducing duplication.

AI Disclosure

No AI

PR quality check

  • Use an expressive title, e.g. "Fix title font property precedence"
  • [N/A] New and changed code is tested
  • [N/A] Plotting related features are demonstrated in an example
  • [N/A] New features and API changes have release notes
  • Documentation complies with general and docstring guidelines

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@melissawm @story645
Split PR guide into two
41c768a 
Co-authored-by: hannah <[email protected]>
@github-actions github-actions Bot added the Documentation: devdocs files in doc/devel label Nov 10, 2026
@melissawm
Fix references
858606f
story645
story645 reviewed Nov 11, 2026
View reviewed changes

@story645 story645 left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

thanks for taking this on!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread doc/devel/pr_guide_maintainers.rst
Comment on lines 48 to 63
@@ -135,24 +61,6 @@ questions by the author.

.. _draft PR: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests

@story645 story645 Nov 11, 2026

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I think this should be in the authors guide rather than the maintainers guide.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@story645 story645 Nov 11, 2026

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

the entire draft section

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
melissawm reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread doc/devel/pr_guide_authors.rst
Comment on lines +39 to +74
* Changes, both new features and bugfixes, should have good test coverage. See
:ref:`testing` for more details.
* Update the :ref:`documentation <pr-documentation>` if necessary.
* All public methods should have informative docstrings with sample usage when
appropriate. Use the :ref:`docstring standards <writing-docstrings>`.
* For high-level plotting functions, consider
:ref:`adding a small example <writing-examples-and-tutorials>` to the
:ref:`examples gallery <gallery>`.
* If you add a new feature or change the API in a backward-incompatible
way, please document it as described in :ref:`api_changes`.
* Code should follow our conventions as documented in our
:ref:`coding_guidelines`.
* When adding or changing public function signatures, add
:ref:`type hints <type-hints>`.
* When adding keyword arguments, see our guide to
:ref:`keyword-argument-processing`.

When opening a pull request on Github, please ensure that:

.. rst-class:: checklist

* Changes were made on a :ref:`feature branch <git-overview>` (i.e. not on the
``main`` branch.)
* :ref:`prek <pre-commit-hooks>` checks for spelling, formatting, etc pass
* The pull request targets the :ref:`main branch <pr-branch-selection>`
* If your pull request addresses an issue, please use the title to describe the
issue (e.g. "Add ability to plot timedeltas") and mention the issue number
in the pull request description to ensure that a link is created to the
original issue (e.g. "Closes #8869" or "Fixes #8869"). This will ensure the
original issue mentioned is automatically closed when your PR is merged. For more
details, see
`linking an issue and pull request <https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>`__.
* :ref:`pr-automated-tests` pass
* You follow the Pull Request template, which includes a checklist of items to
verify before submitting your PR and an :ref:`AI Disclosure <generative_ai>`
section.

@story645 story645 Nov 11, 2026

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

blanking on how at the moment, but any chance we can condense this?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@melissawm melissawm Nov 11, 2026

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Yes will work on it!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
story645 reacted with heart emoji
All reactions
  • ❤️ 1 reaction

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@story645 story645 story645 left review comments

At least 1 approving review is required to merge this pull request.

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

Documentation: devdocs files in doc/devel

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@melissawm @story645
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.