From 7520cf180dabacadbfb3dc5519b7388c8ba022e6 Mon Sep 17 00:00:00 2001 From: Martin Weise <martin.weise@tuwien.ac.at> Date: Sun, 10 Sep 2023 09:24:06 +0200 Subject: [PATCH] Updated templates --- .gitlab/issue_templates/bug_report.md | 21 ++++++++++++++------- .gitlab/issue_templates/change_request.md | 15 ++++++++++----- .gitlab/issue_templates/feature_request.md | 12 ++++++++---- .gitlab/issue_templates/question.md | 3 ++- 4 files changed, 34 insertions(+), 17 deletions(-) diff --git a/.gitlab/issue_templates/bug_report.md b/.gitlab/issue_templates/bug_report.md index 350e523b4c..7277144c09 100644 --- a/.gitlab/issue_templates/bug_report.md +++ b/.gitlab/issue_templates/bug_report.md @@ -1,25 +1,32 @@ -**Describe the bug** +### Describe the bug + A clear and concise description of what the bug is. -**Is this a regression?** +### Is this a regression? + Yes/No. -**To Reproduce** +### To Reproduce + Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +### Expected behavior + A clear and concise description of what you expected to happen. -**Screenshots** +### Screenshots + If applicable, add screenshots to help explain your problem. -**Environment** +### Environment + - Browser [e.g. firefox, chrome] - Damap version [e.g. 2.1.0] -**Additional context** +### Additional context + Add any other context about the problem here. diff --git a/.gitlab/issue_templates/change_request.md b/.gitlab/issue_templates/change_request.md index 96b3e816fe..ab04ad8141 100644 --- a/.gitlab/issue_templates/change_request.md +++ b/.gitlab/issue_templates/change_request.md @@ -1,14 +1,19 @@ -**Changes** +### Changes + Add a description of the task and describe what the task should include. -**Additional notes** +### Additional notes + List any notes you collected that support the original task and include a screenshot if applicable. -**Assumptions** +### Assumptions + List any assumptions that you are aware of but still need to be reviewed. -**Acceptance Criteria** +### Acceptance Criteria + Describe how you think a completed task would look like or how it should work. -**Risks? (optional)** +### Risks? (optional) + Potential risks and how to best mitigate them. diff --git a/.gitlab/issue_templates/feature_request.md b/.gitlab/issue_templates/feature_request.md index 846c561d9d..036713740b 100644 --- a/.gitlab/issue_templates/feature_request.md +++ b/.gitlab/issue_templates/feature_request.md @@ -1,13 +1,17 @@ -**Description** +### Description + A clear and concise description of what you're missing. -**Describe the solution you'd like** +### Describe the solution you'd like + A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +### Describe alternatives you've considered + A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +### Additional context + Add any other context or screenshots about the feature request here. _If this issue requests multiple changes consider using checkboxes or lists._ diff --git a/.gitlab/issue_templates/question.md b/.gitlab/issue_templates/question.md index eeecf4b6e8..c14b666d00 100644 --- a/.gitlab/issue_templates/question.md +++ b/.gitlab/issue_templates/question.md @@ -1 +1,2 @@ -**Description** +### Description + -- GitLab