Skip to content

Commit cac9f28

Browse files
Doc notes for core team members (#35608)
1 parent 32abe63 commit cac9f28

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

doc/source/development/maintaining.rst

+39-3
Original file line numberDiff line numberDiff line change
@@ -132,17 +132,24 @@ respond or self-close their issue if it's determined that the behavior is not a
132132
or the feature is out of scope. Sometimes reporters just go away though, and
133133
we'll close the issue after the conversation has died.
134134

135+
.. _maintaining.reviewing:
136+
135137
Reviewing pull requests
136138
-----------------------
137139

138140
Anybody can review a pull request: regular contributors, triagers, or core-team
139-
members. Here are some guidelines to check.
141+
members. But only core-team members can merge pull requets when they're ready.
142+
143+
Here are some things to check when reviewing a pull request.
140144

141-
* Tests should be in a sensible location.
145+
* Tests should be in a sensible location: in the same file as closely related tests.
142146
* New public APIs should be included somewhere in ``doc/source/reference/``.
143147
* New / changed API should use the ``versionadded`` or ``versionchanged`` directives in the docstring.
144148
* User-facing changes should have a whatsnew in the appropriate file.
145149
* Regression tests should reference the original GitHub issue number like ``# GH-1234``.
150+
* The pull request should be labeled and assigned the appropriate milestone (the next patch release
151+
for regression fixes and small bug fixes, the next minor milestone otherwise)
152+
* Changes should comply with our :ref:`policies.version`.
146153

147154
Cleaning up old issues
148155
----------------------
@@ -189,5 +196,34 @@ being helpful on the issue tracker.
189196
The current list of core-team members is at
190197
https://github.com/pandas-dev/pandas-governance/blob/master/people.md
191198

199+
200+
.. _maintaining.merging:
201+
202+
Merging pull requests
203+
---------------------
204+
205+
Only core team members can merge pull requests. We have a few guidelines.
206+
207+
1. You should typically not self-merge your own pull requests. Exceptions include
208+
things like small changes to fix CI (e.g. pinning a package version).
209+
2. You should not merge pull requests that have an active discussion, or pull
210+
requests that has any ``-1`` votes from a core maintainer. Pandas operates
211+
by consensus.
212+
3. For larger changes, it's good to have a +1 from at least two core team members.
213+
214+
In addition to the items listed in :ref:`maintaining.closing`, you should verify
215+
that the pull request is assigned the correct milestone.
216+
217+
Pull requests merged with a patch-release milestone will typically be backported
218+
by our bot. Verify that the bot noticed the merge (it will leave a comment within
219+
a minute typically). If a manual backport is needed please do that, and remove
220+
the "Needs backport" label once you've done it manually. If you forget to assign
221+
a milestone before tagging, you can request the bot to backport it with:
222+
223+
.. code-block:: console
224+
225+
@Meeseeksdev backport <branch>
226+
227+
192228
.. _governance documents: https://github.com/pandas-dev/pandas-governance
193-
.. _list of permissions: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization
229+
.. _list of permissions: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization

0 commit comments

Comments
 (0)