diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md index b8d2db77ba1b40e3e88a23713eb47d3a1e44296f..ddda018c11cd4093b675bfb0a8cc129eaff14667 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -1,35 +1,18 @@ ## What does this MR do and why? -<!-- -Describe in detail what your merge request does and why. - -Please keep this description updated with any discussion that takes place so -that reviewers can understand your intent. Keeping the description updated is -especially important if they didn't participate in the discussion. ---> - %{first_multiline_commit} ## References -**Please include [cross links](https://handbook.gitlab.com/handbook/communication/#start-with-a-merge-request:~:text=Cross%20link%20issues,alternate%20if%20duplicate.) to any resources that are relevant to this MR**. -This will give reviewers and future readers helpful context to give an efficient review of the changes introduced. - -- - -## MR acceptance checklist - -**Please evaluate this MR against the [MR acceptance checklist](https://docs.gitlab.com/development/code_review/#acceptance-checklist).** -It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability. +<!-- +Include [links](https://handbook.gitlab.com/handbook/communication/#start-with-a-merge-request:~:text=Cross%20link%20issues,alternate%20if%20duplicate.) to any resources that are relevant to this MR. +This will give reviewers and future readers helpful context. +--> ## Screenshots or screen recordings -_Screenshots are required for UI changes, and strongly recommended for all other merge requests._ - -<!-- -Please include any relevant screenshots or screen recordings that will assist -reviewers and future readers. If you need help visually verifying the change, -please leave a comment and ping a GitLab reviewer, maintainer, or MR coach. +<!--- +Screenshots are required for UI changes, and strongly recommended for all other merge requests. --> | Before | After | @@ -37,9 +20,8 @@ please leave a comment and ping a GitLab reviewer, maintainer, or MR coach. | | | <!-- -OPTIONAL: -Use this table when providing screenshots at relevant viewport sizes. -Delete table rows that are not relevant to your changes. +OPTIONAL: For responsive UI changes, you can use the viewport size table below. +Delete this table if not needed or delete rows that are not relevant to your changes. | Viewport size | Before | After | | ----------------| ---------- | ---------- | @@ -52,12 +34,12 @@ Delete table rows that are not relevant to your changes. ## How to set up and validate locally -_Numbered steps to set up and validate the change are strongly suggested._ - <!-- -Example below: +Numbered steps to set up and validate the change are strongly suggested. -1. In rails console enable the experiment fully +Example: + +1. In rails console enable the feature flag ```ruby Feature.enable(:member_areas_of_focus) ``` @@ -65,6 +47,9 @@ Example below: 1. Click the `invite members` button. --> -<!-- template sourced from https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/Default.md --> +## MR acceptance checklist + +Evaluate this MR against the [MR acceptance checklist](https://docs.gitlab.com/development/code_review/#acceptance-checklist). +It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability. /assign me