Add conventional comments style comments
Problem to solve
Create a framework for comments that reduces misunderstanding.
As a user, I would like to have a way to express what I want to say without having to overspecify the tone.
This feature is proposing the implementation from https://conventionalcomments.org/.
Intended users
But actually anyone who can comment on a Merge Request.
User experience goal
The user should be able to see comments in the format
<label> [decoration]: <subject>
[discussion]User should also be able to insert comments with the same format.
Proposal
The user should be able to select the category of the comment from a dropdown. Available categories should be definable on a per-repository basis, defaulting to the recommended list on conventional comments. In addition, a tickbox will enable the "non-blocking" element. Future decoration might change this in a dropdown.
The comment box includes a title (subject), and a separated textarea for discussion.
The comment will be displayed as per format.
Perhaps we could iterate on https://gitlab.com/conventionalcomments/conventional-comments-button
Permissions and Security
No permission changes would be necessary.
Documentation
We would have to update:
- User documentation on:
Availability & Testing
TBD but I imagine we would need
- Unit test changes
- End-to-end test changes
at the very least.
What does success look like, and how can we measure that?
TBD
What is the type of buyer?
Ideally this would land in GitLab Core
Is this a cross-stage feature?
TBD