nixpkgs/.github/STALE-BOT.md
Ryan Mulligan 2118173ca4 .github/stale bot: stop commenting
Niklas Hambüchen noted in

https://github.com/NixOS/rfcs/pull/124#issuecomment-1113647856

that we can add a label description for the stale label that appears
when you hover over the label, or look on

https://github.com/NixOS/nixpkgs/labels

I set the description to be

> https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md

which is our page explaining the stale bot.

The stale bot comments/emails are a significant burden on our most
prodigious contributors, and the reason for their existence to orient
new contributors.

Since our stale bot's configuration is benign enough to ignore (it
does not close), I believe it is good enough to satisfy the new
contributor orientation with the label description.

Therefore, this commit disables commenting when labeling an issue or
PR stale.
2022-04-30 08:30:08 -07:00

3.6 KiB

Stale bot information

  • Thanks for your contribution!
  • Our stale bot will never close an issue or PR.
  • To remove the stale label, just leave a new comment.
  • How to find the right people to ping?git blame to the rescue! (or GitHub's history and blame buttons.)
  • You can always ask for help on our Discourse Forum, our Matrix room, or on the #nixos IRC channel.

Suggestions for PRs

  1. GitHub sometimes doesn't notify people who commented / reviewed a PR previously, when you (force) push commits. If you have addressed the reviews you can officially ask for a review from those who commented to you or anyone else.
  2. If it is unfinished but you plan to finish it, please mark it as a draft.
  3. If you don't expect to work on it any time soon, closing it with a short comment may encourage someone else to pick up your work.
  4. To get things rolling again, rebase the PR against the target branch and address valid comments.
  5. If you need a review to move forward, ask in the Discourse thread for PRs that need help.
  6. If all you need is a merge, check the git history to find and request reviews from people who usually merge related contributions.

Suggestions for issues

  1. If it is resolved (either for you personally, or in general), please consider closing it.
  2. If this might still be an issue, but you are not interested in promoting its resolution, please consider closing it while encouraging others to take over and reopen an issue if they care enough.
  3. If you still have interest in resolving it, try to ping somebody who you believe might have an interest in the topic. Consider discussing the problem in our Discourse Forum.
  4. As with all open source projects, your best option is to submit a Pull Request that addresses this issue. We ❤️ this attitude!

Memorandum on closing issues

Don't be afraid to close an issue that holds valuable information. Closed issues stay in the system for people to search, read, cross-reference, or even reopen--nothing is lost! Closing obsolete issues is an important way to help maintainers focus their time and effort.

Useful GitHub search queries