Skip to content

Split PR guide into two (for authors and for maintainers) - #32588

Open
melissawm wants to merge 3 commits into
matplotlib:mainfrom
melissawm:split-pr-guide
Open

melissawm wants to merge 3 commits into
matplotlib:mainfrom
melissawm:split-pr-guide

Conversation

@melissawm

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

@github-actions github-actions Bot added the Documentation: devdocs files in doc/devel label Nov 10, 2026

@story645 story645 left a comment

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.

thanks for taking this on!

Comment thread doc/devel/pr_guide_maintainers.rst Outdated
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

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 this should be in the authors guide rather than the maintainers guide.

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.

the entire draft section

Comment thread doc/devel/pr_guide_authors.rst Outdated
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.

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.

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

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.

Yes will work on it!

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.

Tried working on the text and moving the details about linking the issue number to the full guide. Let me know what you think!

melissawm and others added 3 commits November 16, 2026 12:37
@melissawm

Copy link
Copy Markdown
Member Author

Re-triggering CircleCI

@melissawm melissawm closed this Nov 16, 2026
@melissawm melissawm reopened this Nov 16, 2026

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

Labels

Documentation: devdocs files in doc/devel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants