Add a Setup & Testing section to the default MR template
Proposal
Add a Setup & Testing
section to the default MR template for GitLab to share how anyone can test the MR changes.
Example from !54219 (merged) |
---|
Problem
The default MR description doesn't have a section sharing how to confirm a MR's changes.
As a reviewer, I want to know how to access and use the changes made in order to test it. It should be made clear:
- What feature flags do I need to enable?
- Where can I find this feature?
- What setup is required to enable / access this?
By adding this, or something similar, we could increase the project's quality by:
- Making it easy to authenticate the quality of MRs by using the feature.
- Making user testing more ubiquitous amongst reviewers by making it less taxing.
As GitLab grows both the application & team I think something like this will become more useful as our scope increases.
Similar to Screenshots
, this wouldn't always be required or applicable for simple changes.
Note
I'm unable to open an MR to make this change as the default template is part of the project settings and I am not a maintainer.