From 70178bb5128bb33502f4686960deae2dea11f42d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thorsten=20Ro=C3=9Fner?= Date: Wed, 3 Sep 2025 15:02:19 +0200 Subject: [PATCH] chore(mr-templates): Update based on feedback from technical weekly --- .gitlab/merge_request_templates/Bugfix.md | 11 +++++++---- .gitlab/merge_request_templates/Default.md | 8 ++++---- .gitlab/merge_request_templates/Update.md | 4 ++-- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.gitlab/merge_request_templates/Bugfix.md b/.gitlab/merge_request_templates/Bugfix.md index 9b577a4f..6f1d7705 100644 --- a/.gitlab/merge_request_templates/Bugfix.md +++ b/.gitlab/merge_request_templates/Bugfix.md @@ -14,16 +14,19 @@ Explain for the reviewer how the change addresses the issue, providing some insi Provida a link to the issue or document the required details below. In case it is a GitLab issue, reference it at the end of the commit message in square brackets, like `[#123]` +Provide steps for QA or reviewers to test the fix and mention anything reviewers should be aware of. -### Before the Fix +### Steps to reproduce 1. ... -### After the Fix +### Actual behaviour -Provide steps for QA or reviewers to test the fix and mention anything reviewers should be aware of: +*Based on the "Steps to reproduce" explain what the user sees while the bug isn't fixed.* -1. ... +### Expected behaviour + +*Based on the "Steps to reproduce" explain what the user gets to see with the bug fix merged.* ## 🔄 Requirements for migrations diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md index 0b7c6ce8..4c6efa11 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -3,11 +3,11 @@ Thank you for your contribution! Please follow these simple guidelines to continue: - Select a MR template in case you contribution is covers more than simple documentation/non functional changes: - - `Update`: Updates of openDesk core applications, these are the ones listed on the [README.md](../../README.md) - - `Bugfix`: For fixes in the platform or in app/dependencies that aren't part of an update release of the openDesk core applications. - - `Feature`: An update in the platform providing support for a specific feature. + - `Update`: Major/minor updates of openDesk core applications, the ones listed on the [README.md](../../README.md). Main commit should be `feat(component): ...` + - `Bugfix`: For (bug)fixes in the platform or non-update/feature releases of the openDesk core applications. Main commit should be `fix(component): ...` + - `Feature`: An update in the platform providing support for a specific feature. Main commit should be `feat(component): ...` - `Other`: All other changes. - - In case you just do a chore/docs commit. + - In case you just do a `chore`/`docs` commit, you can skip the templates from above. - Create MRs early and use the "draft" state to show that this MR isn't ready for review and merge. - Always assign the MR to yourself and set somebody from the development team as reviewer. If you do not know whom to chose leave the reviewer empty. - Flag the MR "ready" as soon as it can be reviewed and QA'd. diff --git a/.gitlab/merge_request_templates/Update.md b/.gitlab/merge_request_templates/Update.md index 70b2ae84..911dfae4 100644 --- a/.gitlab/merge_request_templates/Update.md +++ b/.gitlab/merge_request_templates/Update.md @@ -5,8 +5,8 @@ ## 📋 Changelog/Release Notes -- [ ] [README.md](../../README.md) component table updated including the link to the related release notes -- [ ] Provide significant improvements you'd like to see in the openDesk release notes. If you have a lot of details to provide or someone else is providing the details, please use a comment on the MR and link the comment in here. +- [ ] [README.md](../../README.md) component table updated including the link to the related release notes of the updated application. +- [ ] Provide significant improvements you would like to see in the [openDesk release notes](https://www.opendesk.eu/en/blog/opendesk-1-6). If you have a lot of details to provide or someone else is providing the details, you can use a comment on this MR and provide a link here. ## 🔄 Requirements for migrations