Improve Zulipbot messages #216
Conversation
Codecov Report
@@ Coverage Diff @@
## main #216 +/- ##
=======================================
Coverage 64.80% 64.80%
=======================================
Files 24 24
Lines 1770 1770
=======================================
Hits 1147 1147
Misses 623 623 |
|
These changes all seem like improvements, thanks for doing this! |
config/templates/abandonWarning.md
Outdated
| 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! |
There was a problem hiding this comment.
This should be either “@{assignee}, you …” with a comma or “@{assignee} You …” with a capital letter. (Similarly for other strings.)
| @@ -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 steps **in order** and mark them off when done: | |||
There was a problem hiding this comment.
Arbitrary contributors won’t have permission to edit zulipbot’s comment, such as by checking its checkboxes.
The new language aims to be brief while still providing some motivation for what's happening.
- The new language is more brief. - There is an option for the contributor to say that they won't be updating their PR.
- Adds an explanation of why linking the PR to the issue is helpful. - Links to the commit message documentation.
- Shortens the text. - Adds a link to the contributor guide.
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.
|
I pushed an update addressing all the feedback above. We may want to hold off on merging the last commit (403ec2f) until we also have a fix to check for double assignments at the right time, as it's expected to make that possibility come up more often. |
|
I merged the first 4 commits as the series ending with 36b0fe1. |
|
I was recently reminded of the text of our new contributor Zulipbot messages, and at this point I don't think it's worth waiting for technical changes before we make some improvements. @timabbott would you be comfortable with merging the last commit on this PR? Or maybe we can tweak it a bit to specifically address double assignments, e.g.: "You can contribute by providing feedback on their pull request." -> "You can unassign yourself and contribute by providing feedback on their pull request." |
|
Yeah I think a tweak of that form is probably a reasonable option. |
I generally tried to make the language Zulipbot uses clear but more succinct than it currently is, with links to documentation where relevant.
There are no logic changes, and all the variables used were already in the comment.
This PR also adds a checklist for brand new contributors, to encourage claiming the first issue only when ready. As described in the commit message, I think the way this is implemented here (with no logic changes) is not ideal. But we could try it and see how it goes.
I don't know how to test these changes.