mirror of
https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git
synced 2025-12-06 07:21:36 +01:00
chore(merge_request_templates): Add merge request templates
This commit is contained in:
committed by
Thorsten Roßner
parent
74c4cc309d
commit
5a3e47ea5d
81
.gitlab/merge_request_templates/Bugfix.md
Normal file
81
.gitlab/merge_request_templates/Bugfix.md
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
## 📌 Summary
|
||||||
|
|
||||||
|
Brief description of the issue and what this MR resolves.
|
||||||
|
|
||||||
|
> Example:
|
||||||
|
> Fixes a bug where users were unable to save their profile due to a missing field validation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ Changes
|
||||||
|
|
||||||
|
Explain for the reviewer how the change addresses the issue:
|
||||||
|
|
||||||
|
- Fixed null check on user input
|
||||||
|
- Added unit test for edge case
|
||||||
|
- Updated error handling in the `ProfileService`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧪 Analysis
|
||||||
|
|
||||||
|
Explain the **underlying cause** of the bug:
|
||||||
|
|
||||||
|
- What was the unexpected behavior?
|
||||||
|
- Why did it happen?
|
||||||
|
- Where in the code or logic did it occur?
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 Related Issue(s)
|
||||||
|
|
||||||
|
- Should be listed as part of the commit message.
|
||||||
|
- Fixes #[issue-number]
|
||||||
|
- Related to #[optional additional issues]
|
||||||
|
|
||||||
|
## 🧪 How to Reproduce & Test
|
||||||
|
|
||||||
|
Link to issue or document the required details below.
|
||||||
|
|
||||||
|
### Before the Fix:
|
||||||
|
|
||||||
|
1. Go to `/profile/edit`
|
||||||
|
2. Leave the "email" field empty
|
||||||
|
3. Click "Save"
|
||||||
|
4. Observe 500 server error
|
||||||
|
|
||||||
|
### After the Fix:
|
||||||
|
|
||||||
|
1. Same steps as above
|
||||||
|
2. Now see appropriate validation message
|
||||||
|
3. No server error occurs
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Checklist / Sign-offs
|
||||||
|
|
||||||
|
### 💿 CI/CD
|
||||||
|
|
||||||
|
- [ ] CI pipeline passes for all jobs
|
||||||
|
- [ ] Linting and formatting checks pass
|
||||||
|
- [ ] Review app (if used) reflects fix correctly
|
||||||
|
|
||||||
|
### 🖥 QA & Product
|
||||||
|
|
||||||
|
Set related labels on the MR for
|
||||||
|
|
||||||
|
- [ ] `PO::👀`
|
||||||
|
- [ ] `Tech Lead::👀`
|
||||||
|
- [ ] `Testautomation::👀`
|
||||||
|
- [ ] `QA::👀`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 👷 Developer Checklist
|
||||||
|
|
||||||
|
- [ ] Code builds and passes linting
|
||||||
|
- [ ] Tests added or updated
|
||||||
|
- [ ] Verified fix locally
|
||||||
|
- [ ] Regression testing done for related functionality
|
||||||
|
- [ ] No new warnings or errors in logs
|
||||||
|
|
||||||
@@ -1,16 +1 @@
|
|||||||
<!--
|
Please select one of the templates, in case your contribution contains more than a **simple** typo fix.
|
||||||
SPDX-FileCopyrightText: 2024 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH
|
|
||||||
SPDX-License-Identifier: Apache-2.0
|
|
||||||
-->
|
|
||||||
|
|
||||||
# Summary
|
|
||||||
|
|
||||||
- *describe the reason for/content of the MR*
|
|
||||||
|
|
||||||
# Commits
|
|
||||||
|
|
||||||
%{all_commits}
|
|
||||||
|
|
||||||
# Authors
|
|
||||||
|
|
||||||
%{co_authored_by}
|
|
||||||
|
|||||||
74
.gitlab/merge_request_templates/Feature.md
Normal file
74
.gitlab/merge_request_templates/Feature.md
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
## 📌 Summary
|
||||||
|
|
||||||
|
Briefly describe what this feature MR does and why it’s needed.
|
||||||
|
|
||||||
|
> Example:
|
||||||
|
> Adds user profile editing capabilities to the dashboard. This enables users to update their personal information without admin intervention.*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ Changes
|
||||||
|
|
||||||
|
List the key changes made in this MR:
|
||||||
|
|
||||||
|
- Added new route /profile/edit
|
||||||
|
- Created `ProfileEditForm` component
|
||||||
|
- Integrated with backend API for user updates
|
||||||
|
- Added unit tests and basic form validation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧪 Tests
|
||||||
|
|
||||||
|
Provide steps for QA or reviewers to test the feature.
|
||||||
|
|
||||||
|
1. Login as any user
|
||||||
|
2. Navigate to `/profile/edit`
|
||||||
|
3. Update profile info and save
|
||||||
|
4. Verify changes are persisted and reflected in the UI
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 Related Issue(s)
|
||||||
|
|
||||||
|
- Closes #[issue number]
|
||||||
|
- Depends on #[merge request or issue, if any]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🕵️ Notes for Reviewer
|
||||||
|
|
||||||
|
Mention anything reviewers should be aware of:
|
||||||
|
|
||||||
|
- Known issues or limitations
|
||||||
|
- Code sections that may need special attention
|
||||||
|
- Design considerations or edge cases handled
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Checklist / Sign-offs
|
||||||
|
|
||||||
|
### 💿 CI/CD
|
||||||
|
|
||||||
|
- [ ] CI pipeline passes for all jobs
|
||||||
|
- [ ] Linting and formatting checks pass
|
||||||
|
- [ ] Review app (if used) reflects fix correctly
|
||||||
|
|
||||||
|
### 🖥 QA & Product
|
||||||
|
|
||||||
|
Set related labels on the MR for
|
||||||
|
|
||||||
|
- [ ] `PO::👀`
|
||||||
|
- [ ] `Tech Lead::👀`
|
||||||
|
- [ ] `Testautomation::👀`
|
||||||
|
- [ ] `QA::👀`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 👷 Developer Checklist
|
||||||
|
|
||||||
|
- [ ] Code builds and passes linting
|
||||||
|
- [ ] Tests added or updated
|
||||||
|
- [ ] Verified fix locally
|
||||||
|
- [ ] Regression testing done for related functionality
|
||||||
|
- [ ] No new warnings or errors in logs
|
||||||
33
.gitlab/merge_request_templates/Other.md
Normal file
33
.gitlab/merge_request_templates/Other.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
## 📌 Summary
|
||||||
|
|
||||||
|
Provide a concise summary of **what** this MR does and **why**.
|
||||||
|
|
||||||
|
> Example:
|
||||||
|
> This MR updates the CI configuration to cache NPM dependencies and reduce pipeline execution time.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ Changes
|
||||||
|
|
||||||
|
List the key updates made:
|
||||||
|
|
||||||
|
- ...
|
||||||
|
- ...
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧪 Tests (if applicable)
|
||||||
|
|
||||||
|
Explain how reviewers or CI can verify the change works as intended.
|
||||||
|
|
||||||
|
> Example:
|
||||||
|
>- For CI: Check job `build:frontend` completes in <3 mins.
|
||||||
|
>- For docs: View rendered markdown locally or in GitLab.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧾 Checks
|
||||||
|
|
||||||
|
- [ ] CI passes
|
||||||
|
- [ ] No functional changes
|
||||||
|
- [ ] Verified (if needed)
|
||||||
49
.gitlab/merge_request_templates/Update.md
Normal file
49
.gitlab/merge_request_templates/Update.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
## ⬆️ Application Update
|
||||||
|
|
||||||
|
Expected MR Title and git commit message:
|
||||||
|
|
||||||
|
`feat/fix(<app-name>): Update from <old-version> to <new-version>`
|
||||||
|
|
||||||
|
### 📋 Changelog/Release Notes
|
||||||
|
|
||||||
|
- [ ] Upstream release notes: `[link]`
|
||||||
|
- [ ] No breaking changes (or listed below)
|
||||||
|
- [ ] Relevant changes communicated (if needed)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🔄 Migrations to Run (if any)
|
||||||
|
|
||||||
|
Describe any migrations that need to be performed when upgrading to this application version.
|
||||||
|
|
||||||
|
- [ ] Database migrations
|
||||||
|
- [ ] Configuration changes
|
||||||
|
- [ ] Cache clears / rebuilds
|
||||||
|
- [ ] Other: _describe_
|
||||||
|
|
||||||
|
## Checklist / Sign-offs
|
||||||
|
|
||||||
|
### 💿 CI/CD
|
||||||
|
|
||||||
|
- [ ] CI pipeline passes for all jobs
|
||||||
|
- [ ] Linting and formatting checks pass
|
||||||
|
- [ ] Review app (if used) reflects fix correctly
|
||||||
|
|
||||||
|
### 🖥 QA & Product
|
||||||
|
|
||||||
|
Set related labels on the MR for
|
||||||
|
|
||||||
|
- [ ] `PO::👀`
|
||||||
|
- [ ] `Tech Lead::👀`
|
||||||
|
- [ ] `Testautomation::👀`
|
||||||
|
- [ ] `QA::👀`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 👷 Developer Checklist
|
||||||
|
|
||||||
|
- [ ] Code builds and passes linting
|
||||||
|
- [ ] Tests added or updated
|
||||||
|
- [ ] Verified fix locally
|
||||||
|
- [ ] Regression testing done for related functionality
|
||||||
|
- [ ] No new warnings or errors in logs
|
||||||
Reference in New Issue
Block a user