From 6ffc82b341f460019dcaf814fc79d6baaa8e265e Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Sat, 24 Aug 2019 15:29:55 -0700 Subject: [PATCH 1/7] rfc51: close stale issues initial draft --- rfcs/0051-close-stale-issues.md | 74 +++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 rfcs/0051-close-stale-issues.md diff --git a/rfcs/0051-close-stale-issues.md b/rfcs/0051-close-stale-issues.md new file mode 100644 index 000000000..8163ff3c8 --- /dev/null +++ b/rfcs/0051-close-stale-issues.md @@ -0,0 +1,74 @@ +--- +feature: close-stale-issues +start-date: 2019-08-24 +author: Ryan Mulligan +co-authors: (find a buddy later to help our with the RFC) +shepherd-team: (names, to be nominated and accepted by RFC steering committee) +shepherd-leader: (name to be appointed by RFC steering committee) +related-issues: (will contain links to implementation PRs) +--- + +# Summary +[summary]: #summary + +Close stale Nixpkgs issues and pull requests (hereafter both referred +to as simply "issues") on GitHub using an application provided by +GitHub. + +# Motivation +[motivation]: #motivation + +The Nixpkgs GitHub page has a large number of open issues causing +community angst and misrepresenting the responsiveness of the project. + +By closing stale issues, we can (in an automated way) refocus our +efforts on the ones that have at least one person interested in them. + +# Detailed design +[design]: #detailed-design + +1. Use the [Stale](https://github.com/marketplace/stale) application + provided by GitHub on the [Nixpkgs + repository](https://github.com/NixOS/nixpkgs). +2. Start by using the following `.github/stale.yml` configuration + file: + + ``` + # Number of days of inactivity before an issue becomes stale + daysUntilStale: 60 + # Number of days of inactivity before a stale issue is closed + daysUntilClose: 7 + # Issues with these labels will never be considered stale + exemptLabels: + # Label to use when marking an issue as stale + staleLabel: stale + # Comment to post when marking an issue as stale. Set to `false` to disable + markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. + # Comment to post when closing a stale issue. Set to `false` to disable + closeComment: false + ``` + +# Drawbacks +[drawbacks]: #drawbacks + +People who want to keeps issues open will need to keep indicating +their interest. + +Closing issues might make valueable contributions hard to find. + +Marking issues stale might dissuade contributors who already feel +their contribution was being ignored. + +# Alternatives +[alternatives]: #alternatives + +1. Do nothing +2. Make custom tooling to do something more sophisticated + +# Unresolved questions +[unresolved]: #unresolved-questions + +1. Should we make use of the `exemptLabels` option? From 77e671c2c91339054ce3805bc2c46988b9ee3bba Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Sun, 25 Aug 2019 07:44:28 -0700 Subject: [PATCH 2/7] rfc0051: use staleLabel consistent with nixpkgs labeling conventions --- rfcs/0051-close-stale-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rfcs/0051-close-stale-issues.md b/rfcs/0051-close-stale-issues.md index 8163ff3c8..19d2c7cae 100644 --- a/rfcs/0051-close-stale-issues.md +++ b/rfcs/0051-close-stale-issues.md @@ -41,7 +41,7 @@ efforts on the ones that have at least one person interested in them. # Issues with these labels will never be considered stale exemptLabels: # Label to use when marking an issue as stale - staleLabel: stale + staleLabel: 2.status: stale # Comment to post when marking an issue as stale. Set to `false` to disable markComment: > This issue has been automatically marked as stale because it has not had From 3a763dd1049df2f34586c08aee3530badf40b689 Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Sun, 15 Sep 2019 06:55:21 -0700 Subject: [PATCH 3/7] rfc0051: do not close issues --- ...le-issues.md => 0051-mark-stale-issues.md} | 46 +++++++++++-------- 1 file changed, 27 insertions(+), 19 deletions(-) rename rfcs/{0051-close-stale-issues.md => 0051-mark-stale-issues.md} (56%) diff --git a/rfcs/0051-close-stale-issues.md b/rfcs/0051-mark-stale-issues.md similarity index 56% rename from rfcs/0051-close-stale-issues.md rename to rfcs/0051-mark-stale-issues.md index 19d2c7cae..a8cff52b0 100644 --- a/rfcs/0051-close-stale-issues.md +++ b/rfcs/0051-mark-stale-issues.md @@ -1,5 +1,5 @@ --- -feature: close-stale-issues +feature: mark-stale-issues start-date: 2019-08-24 author: Ryan Mulligan co-authors: (find a buddy later to help our with the RFC) @@ -11,7 +11,7 @@ related-issues: (will contain links to implementation PRs) # Summary [summary]: #summary -Close stale Nixpkgs issues and pull requests (hereafter both referred +Mark stale Nixpkgs issues and pull requests (hereafter both referred to as simply "issues") on GitHub using an application provided by GitHub. @@ -21,8 +21,8 @@ GitHub. The Nixpkgs GitHub page has a large number of open issues causing community angst and misrepresenting the responsiveness of the project. -By closing stale issues, we can (in an automated way) refocus our -efforts on the ones that have at least one person interested in them. +By marking stale issues, we can more easily filter issues for ones +that have at least one person interested in them. # Detailed design [design]: #detailed-design @@ -35,18 +35,35 @@ efforts on the ones that have at least one person interested in them. ``` # Number of days of inactivity before an issue becomes stale - daysUntilStale: 60 + daysUntilStale: 180 # Number of days of inactivity before a stale issue is closed - daysUntilClose: 7 + daysUntilClose: false # Issues with these labels will never be considered stale exemptLabels: + - 1.severity: security # Label to use when marking an issue as stale staleLabel: 2.status: stale # Comment to post when marking an issue as stale. Set to `false` to disable markComment: > - This issue has been automatically marked as stale because it has not had - recent activity. It will be closed if no further activity occurs. Thank you - for your contributions. + Thank you for your contributions. + + This has been automatically marked as stale because it has had no + activity for 180 days. + + If this issue is still important to you, we ask that you leave a + comment below. Your comment can be as simple as "still important to + me". This lets people sorting through the issues see the issues that + at least one person still cares about. Someone will have to do this + at most twice a year if there is no other activity. + + Here are suggestions that might help resolve this more quickly: + + 1. Search for maintainers and people that previously touched the + related code and @ mention them in a comment. + 2. Ask on the [NixOS Discourse](https://discourse.nixos.org/). + 3. Ask on the [#nixos channel](irc://irc.freenode.net/#nixos) on + [irc.freenode.net](https://freenode.net). + # Comment to post when closing a stale issue. Set to `false` to disable closeComment: false ``` @@ -54,10 +71,7 @@ efforts on the ones that have at least one person interested in them. # Drawbacks [drawbacks]: #drawbacks -People who want to keeps issues open will need to keep indicating -their interest. - -Closing issues might make valueable contributions hard to find. +People will need to indicate their interest twice a year. Marking issues stale might dissuade contributors who already feel their contribution was being ignored. @@ -66,9 +80,3 @@ their contribution was being ignored. [alternatives]: #alternatives 1. Do nothing -2. Make custom tooling to do something more sophisticated - -# Unresolved questions -[unresolved]: #unresolved-questions - -1. Should we make use of the `exemptLabels` option? From 7d5d5d2cf96cd4f328bcfbf408b73e11765bd8de Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Mon, 16 Sep 2019 06:15:37 -0700 Subject: [PATCH 4/7] rfc0051: reword motivation --- rfcs/0051-mark-stale-issues.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/rfcs/0051-mark-stale-issues.md b/rfcs/0051-mark-stale-issues.md index a8cff52b0..e53108069 100644 --- a/rfcs/0051-mark-stale-issues.md +++ b/rfcs/0051-mark-stale-issues.md @@ -18,8 +18,9 @@ GitHub. # Motivation [motivation]: #motivation -The Nixpkgs GitHub page has a large number of open issues causing -community angst and misrepresenting the responsiveness of the project. +We have a large number of open issues and PRs that have accumulated +over the years. Not all of them are still valid and need our +attention. By marking stale issues, we can more easily filter issues for ones that have at least one person interested in them. From ad86d598d982bdb8a785d1bb948c25545eeab3b4 Mon Sep 17 00:00:00 2001 From: Peter Simons Date: Tue, 24 Sep 2019 12:21:40 +0200 Subject: [PATCH 5/7] record the members of the shepherd team --- rfcs/0051-mark-stale-issues.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rfcs/0051-mark-stale-issues.md b/rfcs/0051-mark-stale-issues.md index e53108069..a0cb3d5ae 100644 --- a/rfcs/0051-mark-stale-issues.md +++ b/rfcs/0051-mark-stale-issues.md @@ -3,8 +3,8 @@ feature: mark-stale-issues start-date: 2019-08-24 author: Ryan Mulligan co-authors: (find a buddy later to help our with the RFC) -shepherd-team: (names, to be nominated and accepted by RFC steering committee) -shepherd-leader: (name to be appointed by RFC steering committee) +shepherd-team: @globin, @grahamc, and @peti +shepherd-leader: @peti related-issues: (will contain links to implementation PRs) --- From 3bd8135f4f27903369064d0444a5cef4f247ae1a Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Fri, 1 Nov 2019 18:36:41 -0700 Subject: [PATCH 6/7] Update rfcs/0051-mark-stale-issues.md Co-Authored-By: asymmetric --- rfcs/0051-mark-stale-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rfcs/0051-mark-stale-issues.md b/rfcs/0051-mark-stale-issues.md index a0cb3d5ae..5626437b1 100644 --- a/rfcs/0051-mark-stale-issues.md +++ b/rfcs/0051-mark-stale-issues.md @@ -18,7 +18,7 @@ GitHub. # Motivation [motivation]: #motivation -We have a large number of open issues and PRs that have accumulated +We have a large number of open issues that have accumulated over the years. Not all of them are still valid and need our attention. From b0c732ab6a6e9881516846e13b61ac5d092b3260 Mon Sep 17 00:00:00 2001 From: Ryan Mulligan Date: Fri, 1 Nov 2019 18:46:42 -0700 Subject: [PATCH 7/7] [RFC 0051] remove references to "issue" in stale message --- rfcs/0051-mark-stale-issues.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/rfcs/0051-mark-stale-issues.md b/rfcs/0051-mark-stale-issues.md index 5626437b1..6c3973cf3 100644 --- a/rfcs/0051-mark-stale-issues.md +++ b/rfcs/0051-mark-stale-issues.md @@ -51,11 +51,11 @@ that have at least one person interested in them. This has been automatically marked as stale because it has had no activity for 180 days. - If this issue is still important to you, we ask that you leave a - comment below. Your comment can be as simple as "still important to - me". This lets people sorting through the issues see the issues that - at least one person still cares about. Someone will have to do this - at most twice a year if there is no other activity. + If this is still important to you, we ask that you leave a + comment below. Your comment can be as simple as "still important + to me". This lets people see that at least one person still cares + about this. Someone will have to do this at most twice a year if + there is no other activity. Here are suggestions that might help resolve this more quickly: