From 44ae2c5c0930a78876aafd1154599b1763537643 Mon Sep 17 00:00:00 2001 From: Kristina Mazur <kristina.mazur@tum.de> Date: Thu, 19 Dec 2024 11:53:34 +0100 Subject: [PATCH] Add issue and MR template --- .gitlab/issue_templates/Default.md | 18 ++++++++++++ .gitlab/issue_templates/bug_report.md | 22 ++++++++++++++ .../issue_templates/documentation_request.md | 14 +++++++++ .gitlab/issue_templates/feature_request.md | 17 +++++++++++ .gitlab/issue_templates/testing_request.md | 24 +++++++++++++++ .gitlab/issue_templates/todo.md | 16 ++++++++++ .gitlab/merge_request_templates/Default.md | 29 +++++++++++++++++++ 7 files changed, 140 insertions(+) create mode 100644 .gitlab/issue_templates/Default.md create mode 100644 .gitlab/issue_templates/bug_report.md create mode 100644 .gitlab/issue_templates/documentation_request.md create mode 100644 .gitlab/issue_templates/feature_request.md create mode 100644 .gitlab/issue_templates/testing_request.md create mode 100644 .gitlab/issue_templates/todo.md create mode 100644 .gitlab/merge_request_templates/Default.md diff --git a/.gitlab/issue_templates/Default.md b/.gitlab/issue_templates/Default.md new file mode 100644 index 0000000..ed6f8d8 --- /dev/null +++ b/.gitlab/issue_templates/Default.md @@ -0,0 +1,18 @@ +<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name --> + +## Choose Your Issue Template +Before creating an issue, please review existing issues to avoid duplicates! +ALso, select the **appropriate type for your issue in the desciption drop-down**. +- Bug Report Template +- Feature Request Template +- TODO Template +- Documentation Request Template +- Testing Request Template + +If not suitable, use the sections below and contact the owners. + +## Description +Provide a concise description of the issue. + +## Additional Context +Add screenshots, logs, or relevant information here. diff --git a/.gitlab/issue_templates/bug_report.md b/.gitlab/issue_templates/bug_report.md new file mode 100644 index 0000000..b906703 --- /dev/null +++ b/.gitlab/issue_templates/bug_report.md @@ -0,0 +1,22 @@ +<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name --> +# Bug Report + +## Description +Describe the bug clearly. What happened? + +## Steps to Reproduce +1. [Step 1] +2. [Step 2] +3. [Step 3] + +## Expected Behavior +Explain what you expected to see. + +## Environment +- **OS**: [e.g., Windows 10] +- **Version/Branch**: [e.g., v1.2.3] + +## Additional Context +Attach any logs, screenshots, or context. + +/label ~"type::bug" diff --git a/.gitlab/issue_templates/documentation_request.md b/.gitlab/issue_templates/documentation_request.md new file mode 100644 index 0000000..bc94cf6 --- /dev/null +++ b/.gitlab/issue_templates/documentation_request.md @@ -0,0 +1,14 @@ +<!-- Title: Provide a concise and descriptive title for the issue --> +# Documentation + +## Summary +Explain what documentation is missing. + +- **Unicado Version**: vx.x.x +- **Page**: page-to-change + +## Additional Context +Attach any logs, screenshots, or context. + +/label ~"type::documentation" + diff --git a/.gitlab/issue_templates/feature_request.md b/.gitlab/issue_templates/feature_request.md new file mode 100644 index 0000000..2c12fdb --- /dev/null +++ b/.gitlab/issue_templates/feature_request.md @@ -0,0 +1,17 @@ +<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name --> +# Feature Request + +## Summary +What feature are you requesting? + +## Why? +Explain the problem this feature solves or the value it adds. + +## Acceptance Criteria +- [ ] Define measurable outcomes for success. +- [ ] List specific requirements. + +## Additional Notes +Include references, examples, or diagrams if applicable. + +/label ~"type::feature" diff --git a/.gitlab/issue_templates/testing_request.md b/.gitlab/issue_templates/testing_request.md new file mode 100644 index 0000000..0289f4d --- /dev/null +++ b/.gitlab/issue_templates/testing_request.md @@ -0,0 +1,24 @@ +<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name --> +# Testing Issue + +## Summary +Provide a brief overview of what should be tested or changed in the test process. Also think about what is the goal of this test? E.g. +- Verify that [feature/bug fix/module] works as expected. +- Ensure that [specific requirement] is met. + +## Related Issues or Merge Requests +- Issue(s): #[Issue ID] +- Merge Request(s): #[Merge Request ID] + +## Expected Results +- [Outcome 1]: [What should happen]. +- [Outcome 2]: [Another expected result]. + +## Environment +- **OS**: [e.g., Windows 10] +- **Version/Branch**: [e.g., v1.2.3] + +## Additional Context +Attach any logs, screenshots, or context. + +/label ~"type::testing" diff --git a/.gitlab/issue_templates/todo.md b/.gitlab/issue_templates/todo.md new file mode 100644 index 0000000..07bdd0f --- /dev/null +++ b/.gitlab/issue_templates/todo.md @@ -0,0 +1,16 @@ +<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name --> +# TODO + +## Summary +Briefly describe the task. Provide any background information or related issues. + +## Subtasks +- [ ] Step 1 +- [ ] Step 2 +- [ ] Step 3 + +## Acceptance Criteria +- [ ] Define measurable outcomes for success. +- [ ] List specific requirements. + +/label ~"type::todo" diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 0000000..00be17d --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,29 @@ +<!-- Title: Use an imperative, clear title (e.g., "Fix login bug" or "Add new analytics feature") --> + +## Description +Provide a concise explanation of the changes made in this merge request. + +## Related Issue(s) +- Closes #[feature issues] +- Fixes #[bug report issue] +- Resolves #[any other issues] + +### Other Changes +- [Mention refactoring, tests, etc.] + +## Screenshots/Logs +Attach screenshots or log outputs if applicable. + +## Testing Instructions +1. [Step 1: How to test] +2. [Step 2: Expected outcome] +3. [Step 3: Additional steps if required] + +## Developer Checklist +- [ ] Code has been tested locally and/or in pipeline. +- [ ] (if applicable) documentation updated. +- [ ] (if applicable) impact of new dependencies reviewed and included in project. +- [ ] Merge conflicts resolved with the target branch. + +## Additional Notes +Add any information reviewers should focus on, e.g., specific files, functions, or changes of interest. -- GitLab