diff options
author | Evan Read <eread@gitlab.com> | 2022-07-28 09:57:54 +0300 |
---|---|---|
committer | Kati Paizee <kpaizee@gitlab.com> | 2022-07-28 09:57:54 +0300 |
commit | 875ba8f9f7c9581266aee4335e9c8922a59a2570 (patch) | |
tree | 44f66b24f1bd187357a9f575f260b4d71abbf482 /.gitlab | |
parent | ae0622a1e7bb86f51e9b8319c85338e16dfa4825 (diff) |
Refine and consolidate merge request templates for project
Diffstat (limited to '.gitlab')
-rw-r--r-- | .gitlab/merge_request_templates/Default.md | 30 | ||||
-rw-r--r-- | .gitlab/merge_request_templates/Frontend.md | 21 | ||||
-rw-r--r-- | .gitlab/merge_request_templates/Gems Update.md | 5 | ||||
-rw-r--r-- | .gitlab/merge_request_templates/Navbar_item.md | 5 | ||||
-rw-r--r-- | .gitlab/merge_request_templates/Release.md | 5 |
5 files changed, 33 insertions, 33 deletions
diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md index 48ebf8715..47aa9ae1e 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -1,4 +1,34 @@ +## What does this MR do and why? +_Describe [why, not just what](https://about.gitlab.com/handbook/values/#say-why-not-just-what). Include links to relevant issues or discussions._ + +<!-- +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. +--> + +## Screenshots, screen recordings, or links to review app + +_These are strongly recommended to assist reviewers and reduce the time to merge your change._ + +<!-- +Please include any relevant screenshots, screen recordings, or links to the review app that will assist +reviewers and future readers. If you need help visually verifying the change, please leave a comment and +ping a CODEOWNER. +--> + +## How to set up and validate locally + +_Numbered steps to set up and validate the change are strongly suggested._ + +1. [ ] Configure a local GitLab Docs environment: <https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md>. + +## Merge request acceptance checklist + +This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability. + +* [ ] I have evaluated the [MR acceptance checklist](https://docs.gitlab.com/ee/development/code_review.html#acceptance-checklist) for this merge request. /label ~"Category:Docs Site" ~"type::maintenance" /assign me diff --git a/.gitlab/merge_request_templates/Frontend.md b/.gitlab/merge_request_templates/Frontend.md deleted file mode 100644 index 16f34fb9f..000000000 --- a/.gitlab/merge_request_templates/Frontend.md +++ /dev/null @@ -1,21 +0,0 @@ -## Description - -<!-- Describe what this change introduces --> - -## Before and after screenshots - -<!-- Place the before/after screenshots in the table below --> - -| **Before** | **After** | -| :----: | :-----: | -| | | - -## Related issues and links - -<!-- Link any related issues or links that further describe this change --> - - - -<!-- Do not edit below this line --> - -/label ~Frontend diff --git a/.gitlab/merge_request_templates/Gems Update.md b/.gitlab/merge_request_templates/Gems Update.md deleted file mode 100644 index 60f38246e..000000000 --- a/.gitlab/merge_request_templates/Gems Update.md +++ /dev/null @@ -1,5 +0,0 @@ -Update gems using `bundle update`. - -<!-- Do not edit below this line --> - -/label ~backstage diff --git a/.gitlab/merge_request_templates/Navbar_item.md b/.gitlab/merge_request_templates/Navbar_item.md index 8e49496af..f34fe9861 100644 --- a/.gitlab/merge_request_templates/Navbar_item.md +++ b/.gitlab/merge_request_templates/Navbar_item.md @@ -1,7 +1,8 @@ -- Link to the merge request of the new page: +## Add navigation item to global navigation +- [ ] Link to the merge request that introduced the new page: - [ ] Give the MR a descriptive title. -- [ ] Link to the merge request that introduced the new page. +- [ ] Link to the review app showing the new page: /label ~"Category:Docs Site" ~"global nav item" ~"Technical Writing" ~"type::maintenance" /assign me diff --git a/.gitlab/merge_request_templates/Release.md b/.gitlab/merge_request_templates/Release.md deleted file mode 100644 index dc2fb6e40..000000000 --- a/.gitlab/merge_request_templates/Release.md +++ /dev/null @@ -1,5 +0,0 @@ -Follow the process in [Monthly documentation releases](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/releases.md). - -You can also copy its contents here and change the bullet points into checkboxes. - -/label ~release |