From f0edd99bd2cf55a9dd10534946e85504a5adff8d Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Fri, 7 Aug 2020 09:06:46 -0500 Subject: [PATCH 1/4] Doc notes for maintainers --- doc/source/development/maintaining.rst | 37 +++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index 9f9e9dc2631f3..6b8794af2daa0 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -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,29 @@ 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 +the "Needs backport" label once you've done it manually. + + .. _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 \ No newline at end of file +.. _list of permissions: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization From d7af88e1bdb6a72a6ec05158d6d563ca4b8a83e6 Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Mon, 10 Aug 2020 08:15:57 -0500 Subject: [PATCH 2/4] =?UTF-8?q?fix=C2=A7up?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/source/development/maintaining.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index 6b8794af2daa0..d4b2cc5f23dff 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -217,7 +217,12 @@ 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 -the "Needs backport" label once you've done it manually. +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:: + + @Meeseeksdev backport .. _governance documents: https://github.com/pandas-dev/pandas-governance From 258c1a8f62f9023570122c8b4d4dbc0241e4bfec Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Mon, 10 Aug 2020 08:16:49 -0500 Subject: [PATCH 3/4] fixup --- doc/source/development/maintaining.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index d4b2cc5f23dff..1090b09d173f2 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -199,7 +199,7 @@ https://github.com/pandas-dev/pandas-governance/blob/master/people.md .. _maintaining.merging: -Merging Pull Requests +Merging pull requests --------------------- Only core team members can merge pull requests. We have a few guidelines. From 213e13890529b725b6282e73d5a30c3095e5786a Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Mon, 10 Aug 2020 08:43:47 -0500 Subject: [PATCH 4/4] fixup --- doc/source/development/maintaining.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index 1090b09d173f2..cd084ab263477 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -220,7 +220,7 @@ a minute typically). If a manual backport is needed please do that, and remove 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:: +.. code-block:: console @Meeseeksdev backport