Condense Review Roulette comment on MR
Context
@dcroft and I had a conversation today examining this reviewer roulette comment potentially being too verbose than needed. This issue is intended to condense this comment by putting most of the informational text behind a link, have users click into the link if they need help with how a reviewer roulette is built and how to use it.
I also mentioned this being a potential pain point in my Acting EM retrospective issue, specifically this section. So this issue is follow up on this idea.
Current output
Changes that require review have been detected!
Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:
Category | Reviewer | Maintainer |
---|---|---|
backend |
@jon_jenkins |
@sgarg_gitlab |
Please check reviewer's status!
Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.
To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.
Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.
If needed, you can retry the danger-review
job that generated this comment.
Generated by
Desired output:
Category | Reviewer | Maintainer |
---|---|---|
backend |
@jon_jenkins |
@sgarg_gitlab |
Please refer to this link (we need a new handbook page or doc for this) for guidance on how you can benefit from the Reviewer Roulette!
If needed, you can retry the danger-review
job to regenerate this comment, or use the GitLab Review Workload Dashboard
to find other available reviewers..
Generated by
Validation
We should definitely make a feedback issue about this change, ensuring that the new Reviewer Roulette comment doesn't decrease review engagement, and the change doesn't strip out too much information that forces users to hunt for them.