Repository navigation
Conversation
story645
reviewed
Nov 11, 2026
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 | |||
|
|
|||
Member
There was a problem hiding this comment.
I think this should be in the authors guide rather than the maintainers guide.
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. |
Member
There was a problem hiding this comment.
blanking on how at the moment, but any chance we can condense this?
Member
Author
There was a problem hiding this comment.
Tried working on the text and moving the details about linking the issue number to the full guide. Let me know what you think!
Co-authored-by: hannah <story645@gmail.com>
melissawm
force-pushed
the
split-pr-guide
branch
from
November 16, 2026 15:37
9751855 to
d1d539a
Compare
Member
Author
|
Re-triggering CircleCI |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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