From aa35aa13f11ff9188c09a916bd8eaee0dfb62003 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Orb=C3=A1n?= Date: Fri, 18 Feb 2022 17:42:05 +0100 Subject: [PATCH] chore: clarify GitHub action (bot) comments (#34546) For anyone landing on this PR, if you are new to contributing to open source, here is a helpful video with some good tips: [How to Contribute to Open Source (Next.js) ](https://www.youtube.com/watch?v=cuoNzXFLitc) We use two GitHub Actions (here bots) to help us maintain the project better: 1. Stalebot When an issue is triaged, we look for a reproduction and clear steps to reproduce the reported issue. This helps us identify bugs easier, which will result in a quicker resolution of the bug. Skipping these steps could mean that we will not be able to investigate. In these cases, the issue will receive a `please add a complete reproduction` label, that indicates to the original poster (or those following along in the issue) that we would like them to post the missed steps. Unless that happens within 30 days, we are marking the issue as stale. A day after, the issue is automatically closed. If someone finds this now-closed issue later, through the Stalebot we encourage that a new issue will be opened and reference the old one if it holds important/relevant contextual information. The reason is that newer releases might have already fixed the issue that was reported in the first place. This is indicated in the bug report issue template forms. 2. Lockbot This bot is similar to Stalebot, but it strictly operates on **already closed/resolved** issues, it **never** closes ongoing/open issue discussions. An issue can be closed for multiple reasons. It either has been closed by the original poster because they found the solution, or a PR merge included a fix in a recent Next.js release. It is important to look for the reason before commenting. If the issue was seemingly locked by accident, through the Lockbot comment we encourage that a new issue will be opened and reference the old one if it holds important/relevant contextual information. The reason is that newer releases might have already fixed the issue that was reported in the first place. This is indicated in the bug report issue template forms. Important: Issues can be closed/locked by accident, and we encourage everyone to feel welcome opening a new case and reference back to the old issue. Our team values everyone's opinion and we would like to make sure that we resolve any confusion in each individual case. --- .github/workflows/lock.yml | 4 ++-- .github/workflows/stale.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml index bf90a0aaf429..41b7e8c78beb 100644 --- a/.github/workflows/lock.yml +++ b/.github/workflows/lock.yml @@ -20,8 +20,8 @@ jobs: steps: - uses: dessant/lock-threads@v3 with: - github-token: ${{ secrets.LOCK_TOKEN }} + github-token: ${{ secrets.GITHUB_TOKEN }} issue-inactive-days: 30 - issue-comment: 'This issue has been automatically locked due to no recent activity. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.' + issue-comment: 'This closed issue has been automatically locked because it had no new activity for a month. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.' pr-inactive-days: 30 log-output: true diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 9c858d67608b..cb6abe0bc488 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -16,7 +16,7 @@ jobs: with: repo-token: ${{ secrets.STALE_TOKEN }} only-labels: 'please add a complete reproduction' - close-issue-message: 'This issue has been automatically closed after 30 days of inactivity with no reproduction. If you are running into a similar issue, please open a new issue with a reproduction. Thank you.' + close-issue-message: 'This issue has been automatically closed because it received no activity for a month and had no reproduction to investigate. If you think this was closed by accident, please leave a comment. If you are running into a similar issue, please open a new issue with a reproduction. Thank you.' days-before-issue-close: 1 days-before-issue-stale: 30 days-before-pr-close: -1