diff --git a/.gitlab/issue_templates/Default.md b/.gitlab/issue_templates/Default.md index 7ec091e8d13b978ff622a903d9800ab6313661d5..bc16578155289250ba473cdf8a50c45ff68337ad 100644 --- a/.gitlab/issue_templates/Default.md +++ b/.gitlab/issue_templates/Default.md @@ -1,14 +1,20 @@ -## Summary +<!-- Title: Provide a concise and descriptive title for the issue incl. tool or library name --> -**Please choose an appropriate template to categorize your issue.** +## Choose Your Issue Template +<!-- Before creating an issue, please review existing issues to avoid duplicates! --> +<!-- Select the appropriate type for your issue. If not suitable, use the sections below and contact the owners--> +- [Bug Report Template](.gitlab/issue_templates/bug_report.md) +- [Feature Request Template](.gitlab/issue_templates/feature_request.md) +- [TODO Template](.gitlab/issue_templates/todo.md) +- [Documentation Request Template](.gitlab/issue_templates/documentation_request.md) +- [Testing Request Template](.gitlab/issue_templates/testing_request.md) -(Summarize the issue concisely) +--- -- **Unicado Version**: vx.x.x -- **Page**: page-name +## Description +Provide a concise description of the issue. -## Additional information +## Additional Context +Add screenshots, logs, or relevant information here. -(Paste any relevant information to further describe the issue) - -/label ~"needs information" +--- \ No newline at end of file diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md deleted file mode 100644 index eb76f7319f7f5a916a33a9d0986f251073b5ba14..0000000000000000000000000000000000000000 --- a/.gitlab/issue_templates/Documentation.md +++ /dev/null @@ -1,14 +0,0 @@ -## Summary - -(Explain what documentation is missing.) - -- **Unicado Version**: vx.x.x -- **Page**: page-to-change - -## Further details - -(Give further details why and how the documentation can be improved -if applicable.) - -/label ~"type::documentation" - diff --git a/.gitlab/issue_templates/Todo.md b/.gitlab/issue_templates/Todo.md deleted file mode 100644 index a1b805c1ddd5c453e4085ac74daad81d6602a94b..0000000000000000000000000000000000000000 --- a/.gitlab/issue_templates/Todo.md +++ /dev/null @@ -1,12 +0,0 @@ -## Summary - -(Summarize the todo concisely) - -- **Page**: page-name - -## Steps to do - -- [ ] Add the steps you need to do. - -/label ~"type::todo" - diff --git a/.gitlab/issue_templates/bug_report.md b/.gitlab/issue_templates/bug_report.md new file mode 100644 index 0000000000000000000000000000000000000000..b906703dce8a5a8d1ca99bd5a36d980f6a2fc26a --- /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 0000000000000000000000000000000000000000..bc94cf6d704aa0645ae950ba690cc716b81659f1 --- /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 0000000000000000000000000000000000000000..2c12fdb6bfc6f26eec57a4c7b1b228b65d991e24 --- /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 0000000000000000000000000000000000000000..0289f4df34cec1c786d637480d7456bbf20b3d08 --- /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 0000000000000000000000000000000000000000..07bdd0f8b2e7294d7949344698e4426530efc826 --- /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 index 2f359d0f5c3fbc11ddd0a4b4ade1075694e14081..00be17dc34a7fc90bb7096112e57c895a2f6d4bf 100644 --- a/.gitlab/merge_request_templates/Default.md +++ b/.gitlab/merge_request_templates/Default.md @@ -1,16 +1,29 @@ -## What does this MR do and why? +<!-- Title: Use an imperative, clear title (e.g., "Fix login bug" or "Add new analytics feature") --> -- **Page**: page-name +## Description +Provide a concise explanation of the changes made in this merge request. -(Describe in detail what your merge request does and why. +## Related Issue(s) +- Closes #[feature issues] +- Fixes #[bug report issue] +- Resolves #[any other issues] -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.) +### Other Changes +- [Mention refactoring, tests, etc.] -%{first_multiline_commit} +## Screenshots/Logs +Attach screenshots or log outputs if applicable. -## How to set up and validate locally +## Testing Instructions +1. [Step 1: How to test] +2. [Step 2: Expected outcome] +3. [Step 3: Additional steps if required] -(Please provide instructions if your MR needs special commands or packages -to work which are not part of the standard Unicado Package.) +## 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.