Skip to content
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

[RFC 0051] Mark stale nixpkgs issues #51

Merged
merged 8 commits into from
Nov 14, 2019
83 changes: 83 additions & 0 deletions rfcs/0051-mark-stale-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
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: @globin, @grahamc, and @peti
shepherd-leader: @peti
related-issues: (will contain links to implementation PRs)
---

# Summary
[summary]: #summary

Mark stale Nixpkgs issues and pull requests (hereafter both referred
to as simply "issues") on GitHub using an application provided by
GitHub.

# Motivation
[motivation]: #motivation

We have a large number of open issues and PRs that have accumulated
ryantm marked this conversation as resolved.
Show resolved Hide resolved
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By marking stale issues, we can more easily filter issues for ones
By marking stale issues, we can more easily filter for ones

Don't think we need the repetition here.

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: 180
# Number of days of inactivity before a stale issue is closed
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: >
Thank you for your contributions.

This has been automatically marked as stale because it has had no
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This has been automatically marked as stale because it has had no
This issue has been automatically marked as stale because it has had no

Or if the problem is that it applies to PRs as well, then I'd remove "issue" from 2 lines below too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks; I resolved this by removing "issue" from the stale message.

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
ryantm marked this conversation as resolved.
Show resolved Hide resolved
at least one person still cares about. Someone will have to do this
at most twice a year if there is no other activity.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear what this is referring to. Is someone going to check for stale issues twice a year? If so, should we mention when exactly?

Maybe this whole sentence can actually be removed, as I don't think it's relevant for people who care about an issue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's referring to the interval the bot would re-mark issues as stale.


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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pointing people to the community channels is a great idea!


# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
```

# Drawbacks
[drawbacks]: #drawbacks

People will need to indicate their interest twice a year.

Marking issues stale might dissuade contributors who already feel
their contribution was being ignored.

# Alternatives
[alternatives]: #alternatives

1. Do nothing