-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
Doc notes for core team members #35608
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -132,17 +132,24 @@ respond or self-close their issue if it's determined that the behavior is not a | |
or the feature is out of scope. Sometimes reporters just go away though, and | ||
we'll close the issue after the conversation has died. | ||
|
||
.. _maintaining.reviewing: | ||
|
||
Reviewing pull requests | ||
----------------------- | ||
|
||
Anybody can review a pull request: regular contributors, triagers, or core-team | ||
members. Here are some guidelines to check. | ||
members. But only core-team members can merge pull requets when they're ready. | ||
|
||
Here are some things to check when reviewing a pull request. | ||
|
||
* Tests should be in a sensible location. | ||
* Tests should be in a sensible location: in the same file as closely related tests. | ||
* New public APIs should be included somewhere in ``doc/source/reference/``. | ||
* New / changed API should use the ``versionadded`` or ``versionchanged`` directives in the docstring. | ||
* User-facing changes should have a whatsnew in the appropriate file. | ||
* Regression tests should reference the original GitHub issue number like ``# GH-1234``. | ||
* The pull request should be labeled and assigned the appropriate milestone (the next patch release | ||
for regression fixes and small bug fixes, the next minor milestone otherwise) | ||
* Changes should comply with our :ref:`policies.version`. | ||
|
||
Cleaning up old issues | ||
---------------------- | ||
|
@@ -189,5 +196,34 @@ being helpful on the issue tracker. | |
The current list of core-team members is at | ||
https://github.com/pandas-dev/pandas-governance/blob/master/people.md | ||
|
||
|
||
.. _maintaining.merging: | ||
|
||
Merging pull requests | ||
--------------------- | ||
|
||
Only core team members can merge pull requests. We have a few guidelines. | ||
|
||
1. You should typically not self-merge your own pull requests. Exceptions include | ||
things like small changes to fix CI (e.g. pinning a package version). | ||
2. You should not merge pull requests that have an active discussion, or pull | ||
requests that has any ``-1`` votes from a core maintainer. Pandas operates | ||
by consensus. | ||
3. For larger changes, it's good to have a +1 from at least two core team members. | ||
|
||
In addition to the items listed in :ref:`maintaining.closing`, you should verify | ||
that the pull request is assigned the correct milestone. | ||
|
||
Pull requests merged with a patch-release milestone will typically be backported | ||
by our bot. Verify that the bot noticed the merge (it will leave a comment within | ||
a minute typically). If a manual backport is needed please do that, and remove | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. in the first instance, could we ask the original PR author to do that |
||
the "Needs backport" label once you've done it manually. If you forget to assign | ||
a milestone before tagging, you can request the bot to backport it with: | ||
|
||
.. code-block:: console | ||
|
||
@Meeseeksdev backport <branch> | ||
|
||
|
||
.. _governance documents: https://github.com/pandas-dev/pandas-governance | ||
.. _list of permissions: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization | ||
.. _list of permissions: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization |
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.
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.
add
@Meeseeksdev backport 1.1.x
to trigger the bot (if needed)