From bc738e6c0397159cf4b54aba8ec7ba51cee1a870 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Fri, 15 Apr 2022 13:23:49 -0700 Subject: [PATCH 1/5] templates: Improve warnings for abandoned issues. The new language aims to be brief while still providing some motivation for what's happening. --- config/templates/abandonWarning.md | 6 +----- config/templates/inactiveWarning.md | 8 ++------ 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/config/templates/abandonWarning.md b/config/templates/abandonWarning.md index 07d1754..94c5f98 100644 --- a/config/templates/abandonWarning.md +++ b/config/templates/abandonWarning.md @@ -1,5 +1 @@ -Hello @{assignee}, you have been unassigned from this issue because you have not updated this issue or any referenced pull requests for over {total} days. - -You can reclaim this issue or claim any other issue by commenting `@{username} claim` on that issue. - -Thanks for your contributions, and hope to see you again soon! +@{assignee} You have been unassigned from this issue because you have not made any updates for over {total} days. Please feel free to reclaim the issue if you decide to pick up again. Thanks! diff --git a/config/templates/inactiveWarning.md b/config/templates/inactiveWarning.md index 29b2a22..9827e2a 100644 --- a/config/templates/inactiveWarning.md +++ b/config/templates/inactiveWarning.md @@ -1,9 +1,5 @@ -Hello @{assignee}, you claimed this issue to work on it, but this issue and any referenced pull requests haven't been updated for {remind} days. Are you still working on this issue? +@{assignee} We noticed that you have not made any updates to this issue or linked PRs for {remind} days. Please comment here if you are still actively working on it. Otherwise, we'd appreciate a quick `@{username} abandon` comment so that someone else can claim this issue and continue from where you left off. -If so, please update this issue by leaving a comment on this issue to let me know that you're still working on it. Otherwise, I'll automatically remove you from this issue in {abandon} days. - -If you've decided to work on something else, simply comment `@{username} abandon` so that someone else can claim it and continue from where you left off. - -Thank you for your valuable contributions to Zulip! +If we don't hear back, you will be automatically unassigned in {abandon} days. Thanks! From 235b118f1fb8e922ec468d08cfbec83a071484c5 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Fri, 15 Apr 2022 13:28:09 -0700 Subject: [PATCH 2/5] templates: Improve review management comments. - The new language is more brief. - There is an option for the contributor to say that they won't be updating their PR. --- config/templates/needsReviewWarning.md | 4 +--- config/templates/updateWarning.md | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/config/templates/needsReviewWarning.md b/config/templates/needsReviewWarning.md index 1a08d34..ee48475 100644 --- a/config/templates/needsReviewWarning.md +++ b/config/templates/needsReviewWarning.md @@ -1,3 +1 @@ -Hello @{assignees}, @{author} updated this pull request over {days} days ago in response to your review, but you haven't checked back in on their changes! Please leave some feedback for them or mark this pull request as ready for merging. - -Thank you for reviewing this pull request! +Hello @{assignees}, @{author} updated this pull request over {days} days ago in response to your review. Please leave some feedback on next steps for this PR. Thanks! diff --git a/config/templates/updateWarning.md b/config/templates/updateWarning.md index 3bd5f95..7fd54a9 100644 --- a/config/templates/updateWarning.md +++ b/config/templates/updateWarning.md @@ -1,5 +1,3 @@ -Hello @{author}, a Zulip maintainer reviewed this pull request over {days} days ago, but you haven't updated your pull request since. Please take a look at the requested changes and update your pull request accordingly. - -Thank you for your valuable contributions to Zulip! +@{author} A Zulip maintainer reviewed this PR over {days} days ago. Please take a look at the requested changes and update your PR, or leave a comment if you will not be able to do so soon. Thanks! From d2ed1f48d0d4ca705914d0e39a5d135946bdfe99 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Fri, 15 Apr 2022 13:46:34 -0700 Subject: [PATCH 3/5] templates: Improve fixCommitWarning. - Adds an explanation of why linking the PR to the issue is helpful. - Links to the commit message documentation. --- config/templates/fixCommitWarning.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config/templates/fixCommitWarning.md b/config/templates/fixCommitWarning.md index 2530e29..69142ca 100644 --- a/config/templates/fixCommitWarning.md +++ b/config/templates/fixCommitWarning.md @@ -1,4 +1,4 @@ -Hello @{author}, it seems like you have referenced #{issues} in your pull request description, but you have not referenced {issuePronoun} in your commit message description(s). When you reference an issue in a commit message, it automatically closes the corresponding issue when the commit is merged. +Hello @{author}, it seems like you have referenced #{issues} in your pull request description, but you have not referenced {issuePronoun} in your commit message description(s). Referencing an issue in a commit message automatically closes the corresponding issue when the commit is merged, which makes the issue tracker easier to manage. Please run `git commit --amend` in your command line client to amend your commit message description with `Fixes #{fixIssues}.`. @@ -14,6 +14,6 @@ Date: Sat Mar 18 13:42:40 2017 -0700 Fixes #51. ``` -Thank you for your contributions to Zulip! +To learn how to write a great commit message, please refer to our [guide](https://zulip.readthedocs.io/en/latest/contributing/version-control.html#commit-messages). From 37eb20d5f1df45cc25879c22b2e22bc4b425d569 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Fri, 15 Apr 2022 13:48:52 -0700 Subject: [PATCH 4/5] templates: Improve multipleClaimWarning. - Shortens the text. - Adds a link to the contributor guide. --- config/templates/multipleClaimWarning.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/config/templates/multipleClaimWarning.md b/config/templates/multipleClaimWarning.md index 0144e38..ce306d5 100644 --- a/config/templates/multipleClaimWarning.md +++ b/config/templates/multipleClaimWarning.md @@ -1,3 +1 @@ -Hello @{commenter}, it looks like someone has already claimed this issue! Since we believe multiple assignments to the same issue may cause some confusion, we encourage you to search for other unclaimed issues to work on. However, you can always reclaim this issue if no one is working on it. - -We look forward to your valuable contributions! +@{commenter} This issue cannot be claimed, as someone else is already working on it. Please see our [contributor guide](https://zulip.readthedocs.io/en/latest/overview/contributing.html#your-first-codebase-contribution) for advice on finding an issue to work on. Thanks! From 403ec2fb083609e71dceea558fb90b932f099bf3 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Fri, 15 Apr 2022 13:31:59 -0700 Subject: [PATCH 5/5] templates: Add list of steps to new contributor message. The goal here is to encourage folks not to claim an issue until they are ready. We will need to make sure that they don't get assigned the issue if someone else claims it in the meantime. We're counting on the contributor not to accept the GitHub invite until ready, which is not ideal because (a) they might just accept it, and (b) there's a risk that the invite will expire. So we'd probably be better off splitting this into two interactions (joining repo; claiming issue). This also shortens the message if the initial invite hasn't been accepted. --- config/templates/contributorAddition.md | 13 ++++++------- config/templates/inviteError.md | 4 +--- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/config/templates/contributorAddition.md b/config/templates/contributorAddition.md index 8d997b6..6b468c4 100644 --- a/config/templates/contributorAddition.md +++ b/config/templates/contributorAddition.md @@ -1,10 +1,9 @@ -Welcome to Zulip, @{commenter}! We just sent you an invite to collaborate on this repository at https://github.com/{repoOwner}/{repoName}/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip! +Welcome to Zulip, @{commenter}! To get started, please take the following three steps **in order**: -Here's some tips to get you off to a good start: +1. Complete all the steps in the [Your first codebase contribution](https://zulip.readthedocs.io/en/latest/overview/contributing.html#your-first-codebase-contribution) section of the [Zulip contributor guide](https://zulip.readthedocs.io/en/latest/contributing/index.html) up to "Claiming an issue". +2. Post a comment here describing your plan for how to approach this issue. Before you claim an issue, you should be confident that you will be able to tackle it effectively. +3. Accept the invite to collaborate on this repository at https://github.com/{repoOwner}/{repoName}/invitations. To avoid filling your inbox, we recommend [unwatching this repository](https://help.github.com/articles/unwatching-repositories/). -- Join me on the [Zulip developers' server](https://chat.zulip.org), to get help, chat about this issue, and meet the other developers. -- [Unwatch this repository](https://help.github.com/articles/unwatching-repositories/), so that you don't get 100 emails a day. +The issue will be assigned to you when all three steps have been completed. -As you work on this issue, you'll also want to refer to the [Zulip code contribution guide](https://zulip.readthedocs.io/en/latest/contributing/index.html), as well as the rest of the developer documentation on that site. - -See you on the other side (that is, the pull request side)! +If someone else claims this issue while you're working through the checklist, no worries! You can contribute by providing feedback on their pull request. If you’ve made good progress in understanding part of the codebase, you can also find another “help wanted” issue in the same area to work on. diff --git a/config/templates/inviteError.md b/config/templates/inviteError.md index 2f14667..3d748bc 100644 --- a/config/templates/inviteError.md +++ b/config/templates/inviteError.md @@ -1,3 +1 @@ -Hello @{commenter}, it looks like we've already sent you a collaboration invite at https://github.com/{repoOwner}/{repoName}/invitations, but you haven't accepted it yet! - -Please accept the invite and try to claim this issue again afterwards. We look forward to your contributions! +@{commenter} It looks like we've already sent you a collaboration invite at https://github.com/{repoOwner}/{repoName}/invitations, but you haven't accepted it yet. Please accept the invite, and then try to claim this issue again. Thanks!