From 7650fbccc72c303eaa51a8b8a7379ff9bb673f0e Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Fri, 23 Aug 2019 22:37:27 -0400 Subject: [PATCH 1/9] Add guidelines for triagers closing PRs --- triaging.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/triaging.rst b/triaging.rst index 960fc7ffa..008d464fc 100644 --- a/triaging.rst +++ b/triaging.rst @@ -36,6 +36,12 @@ Responsibilities include: - Skip issue - Good first issue - Other categorizations + + .. note:: + + Triagers should only close PRs that could be considered spam. They can + suggest for other PRs to be closed, but core developers are responsible for + making the final decision. It is also of paramount importance to treat every contributor to the Python project kindly and with respect. Regardless of whether they're entirely new From 6caf6d4a107235b507b7d84ddeae85318304e547 Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Fri, 23 Aug 2019 23:18:11 -0400 Subject: [PATCH 2/9] Fix indentation level --- triaging.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/triaging.rst b/triaging.rst index 008d464fc..955fd0fe4 100644 --- a/triaging.rst +++ b/triaging.rst @@ -39,9 +39,9 @@ Responsibilities include: .. note:: - Triagers should only close PRs that could be considered spam. They can - suggest for other PRs to be closed, but core developers are responsible for - making the final decision. + Triagers should only close PRs that could be considered spam. They can + suggest for other PRs to be closed, but core developers are responsible for + making the final decision. It is also of paramount importance to treat every contributor to the Python project kindly and with respect. Regardless of whether they're entirely new From cc83c0028d52bfdf25e815693adca2edc444fa6c Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Thu, 29 Aug 2019 16:04:37 -0400 Subject: [PATCH 3/9] Add mariatta's suggestions --- triaging.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/triaging.rst b/triaging.rst index 955fd0fe4..09027f22e 100644 --- a/triaging.rst +++ b/triaging.rst @@ -28,7 +28,6 @@ Responsibilities include: * PR/issue management - Renaming PRs - Reviewing PRs - - Closing PRs and issues - Assisting contributors - Notifying appropriate core developers * Applying appropriate labels to PRs/Issues @@ -39,9 +38,11 @@ Responsibilities include: .. note:: - Triagers should only close PRs that could be considered spam. They can - suggest for other PRs to be closed, but core developers are responsible for - making the final decision. + Although triagers have the permission to close PRs/issues, a core + developer must take the final action in doing so. A triager should + never directly close a PR/issue. Instead, triagers can make use of the + ``stale`` and ``invalid`` labels to suggest that it should be closed. + It is also of paramount importance to treat every contributor to the Python project kindly and with respect. Regardless of whether they're entirely new @@ -100,7 +101,8 @@ invalid Used manually for PRs that do not meet basic requirements and automatically added by bedevere when PR authors attempt to merge maintenace branches into the master branch. During competitions, this label causes the - PR to not count towards the author's contributions. + PR to not count towards the author's contributions. This label is generally + used to suggest that a PR should be closed. needs backport to X.Y Used for PRs which are appropriate to backport to @@ -124,7 +126,13 @@ skip news in another PR. Any potentially impactful changes should have a corresponding news entry, but for trivial changes it's commonly at the discretion of the PR author if they wish to opt-out of making one. - + +stale + Used for PRs which have not received a response from the author in a + significant period of time or are no longer relevant. This label is + generally used to suggest that the PR should be closed. In some cases, + it is appropriate to open an updated version of the PR. + OS-X Used for PRs involving changes which only have an effect upon a specific operating system. Current variations of the label include From fe7434e001f349ffe72b9a1407bb29982f8ce416 Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Fri, 30 Aug 2019 04:06:13 -0400 Subject: [PATCH 4/9] Clarify closing guidelines Based on feedback from Ammar Akar, clarify closing guidelines to only restrict the closing of PRs, not bpo issues. --- triaging.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/triaging.rst b/triaging.rst index 09027f22e..40ed24fce 100644 --- a/triaging.rst +++ b/triaging.rst @@ -38,9 +38,9 @@ Responsibilities include: .. note:: - Although triagers have the permission to close PRs/issues, a core + Although triagers have the permission to close PRs, a core developer must take the final action in doing so. A triager should - never directly close a PR/issue. Instead, triagers can make use of the + never directly close a PR. Instead, triagers can make use of the ``stale`` and ``invalid`` labels to suggest that it should be closed. From 278c5242da3bed495bf345a82241fb0213a9d80d Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Fri, 30 Aug 2019 20:35:04 -0400 Subject: [PATCH 5/9] Add suggestion from ammaraskar and improve phrasing Also, add a reference label for the GitHub PR labels section --- triaging.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/triaging.rst b/triaging.rst index 40ed24fce..820853d1a 100644 --- a/triaging.rst +++ b/triaging.rst @@ -37,12 +37,16 @@ Responsibilities include: - Other categorizations .. note:: - - Although triagers have the permission to close PRs, a core - developer must take the final action in doing so. A triager should - never directly close a PR. Instead, triagers can make use of the - ``stale`` and ``invalid`` labels to suggest that it should be closed. - + + Triagers may have some understanding of when a PR should be closed, but the + final decision must be made by a core developer. This is because the creation + of a PR constitutes a significant amount of effort from the author. Closing one + without careful consideration and proper handling can easily dissaude the + author from making further contributions. + + Instead of directly closing a PR, triagers can make use of the ``invalid`` and + ``stale`` labels to suggest that it should be closed. For more information, see + the :ref:`GitHub PR labels ` section. It is also of paramount importance to treat every contributor to the Python project kindly and with respect. Regardless of whether they're entirely new @@ -79,6 +83,7 @@ For every new triager, it would be great to announce them in the python-committe mailing list and core-workflow category in Discourse. `Example announcement `_. +.. _github-pr-labels: GitHub Labels for PRs ''''''''''''''''''''' From 5375420667a87a46c0cd6eae846554956e016340 Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Fri, 30 Aug 2019 20:46:16 -0400 Subject: [PATCH 6/9] Remove reST note directive --- triaging.rst | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/triaging.rst b/triaging.rst index 820853d1a..8801927ab 100644 --- a/triaging.rst +++ b/triaging.rst @@ -35,18 +35,16 @@ Responsibilities include: - Skip issue - Good first issue - Other categorizations - - .. note:: - Triagers may have some understanding of when a PR should be closed, but the - final decision must be made by a core developer. This is because the creation - of a PR constitutes a significant amount of effort from the author. Closing one - without careful consideration and proper handling can easily dissaude the - author from making further contributions. +Triagers may have some understanding of when a PR should be closed, but the +final decision must be made by a core developer. This is because the creation +of a PR constitutes a significant amount of effort from the author. Closing one +without careful consideration and proper handling can easily dissaude the +author from making further contributions. - Instead of directly closing a PR, triagers can make use of the ``invalid`` and - ``stale`` labels to suggest that it should be closed. For more information, see - the :ref:`GitHub PR labels ` section. +Instead of directly closing a PR, triagers can make use of the ``invalid`` and +``stale`` labels to suggest that it should be closed. For more information, see +the :ref:`GitHub PR labels ` section. It is also of paramount importance to treat every contributor to the Python project kindly and with respect. Regardless of whether they're entirely new From 1f23826248793b9bd57fcde86c70449712c9f9f4 Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Fri, 30 Aug 2019 21:20:44 -0400 Subject: [PATCH 7/9] Remove stale label section --- triaging.rst | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/triaging.rst b/triaging.rst index 8801927ab..ded2c5570 100644 --- a/triaging.rst +++ b/triaging.rst @@ -129,13 +129,7 @@ skip news in another PR. Any potentially impactful changes should have a corresponding news entry, but for trivial changes it's commonly at the discretion of the PR author if they wish to opt-out of making one. - -stale - Used for PRs which have not received a response from the author in a - significant period of time or are no longer relevant. This label is - generally used to suggest that the PR should be closed. In some cases, - it is appropriate to open an updated version of the PR. - + OS-X Used for PRs involving changes which only have an effect upon a specific operating system. Current variations of the label include From 62f1f9e470ad42af1b5402907bb49d583acd2738 Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Sun, 1 Sep 2019 20:51:58 -0400 Subject: [PATCH 8/9] Apply suggestions from willingc Co-Authored-By: Carol Willing --- triaging.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/triaging.rst b/triaging.rst index ded2c5570..9f31466f7 100644 --- a/triaging.rst +++ b/triaging.rst @@ -36,13 +36,11 @@ Responsibilities include: - Good first issue - Other categorizations -Triagers may have some understanding of when a PR should be closed, but the +As triagers gain experience, they may have some intuition of when a PR should be closed. The triager can recommend closing a PR, but the final decision must be made by a core developer. This is because the creation of a PR constitutes a significant amount of effort from the author. Closing one -without careful consideration and proper handling can easily dissaude the -author from making further contributions. -Instead of directly closing a PR, triagers can make use of the ``invalid`` and +Triagers can make use of the ``invalid`` and ``stale`` labels to suggest that it should be closed. For more information, see the :ref:`GitHub PR labels ` section. From 93554a0456c8836a84f7fb0a82daf456b1e583bf Mon Sep 17 00:00:00 2001 From: Kyle Stanley Date: Mon, 2 Sep 2019 22:21:44 -0400 Subject: [PATCH 9/9] Apply suggestions from willingc Co-Authored-By: Carol Willing --- triaging.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/triaging.rst b/triaging.rst index 9f31466f7..ab8c6ce95 100644 --- a/triaging.rst +++ b/triaging.rst @@ -36,13 +36,15 @@ Responsibilities include: - Good first issue - Other categorizations -As triagers gain experience, they may have some intuition of when a PR should be closed. The triager can recommend closing a PR, but the -final decision must be made by a core developer. This is because the creation -of a PR constitutes a significant amount of effort from the author. Closing one +As triagers gain experience, they may have some intuition of when a PR should +be closed. Triagers can recommend closing a PR, but the final decision must be +made by a core developer. By having triagers and core developers work together, +the author receives a careful consideration of their PR. This encourages future +contributions, regardless of whether their PR is accepted or closed. -Triagers can make use of the ``invalid`` and -``stale`` labels to suggest that it should be closed. For more information, see -the :ref:`GitHub PR labels ` section. +Triagers can make use of the ``invalid`` and ``stale`` labels to suggest that a +PR may be suitable for closure. For more information, see the +:ref:`GitHub PR labels ` section. It is also of paramount importance to treat every contributor to the Python project kindly and with respect. Regardless of whether they're entirely new @@ -101,9 +103,9 @@ expert-asyncio invalid Used manually for PRs that do not meet basic requirements and automatically added by bedevere when PR authors attempt to merge maintenace - branches into the master branch. During competitions, this label causes the - PR to not count towards the author's contributions. This label is generally - used to suggest that a PR should be closed. + branches into the master branch. During events such as the October + Hacktoberfest, this label will prevent the PR from counting toward the + author's contributions. needs backport to X.Y Used for PRs which are appropriate to backport to