Skip to content
Snippets Groups Projects
Commit 38d7fdf4 authored by Kristina Mazur's avatar Kristina Mazur
Browse files

Adapt issue and MR templates

parent b2a28c72
No related branches found
No related tags found
2 merge requests!76Draft: Updated Python code example,!73Initial open source version
Pipeline #1562067 passed
## 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 ## Description
- **Page**: page-name 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) ---
\ No newline at end of file
/label ~"needs information"
## Summary
(Summarize the todo concisely)
- **Page**: page-name
## Steps to do
- [ ] Add the steps you need to do.
/label ~"type::todo"
<!-- 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"
## Summary <!-- Title: Provide a concise and descriptive title for the issue -->
# Documentation
(Explain what documentation is missing.) ## Summary
Explain what documentation is missing.
- **Unicado Version**: vx.x.x - **Unicado Version**: vx.x.x
- **Page**: page-to-change - **Page**: page-to-change
## Further details ## Additional Context
Attach any logs, screenshots, or context.
(Give further details why and how the documentation can be improved
if applicable.)
/label ~"type::documentation" /label ~"type::documentation"
<!-- 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"
<!-- 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"
<!-- 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"
## 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 ### Other Changes
that reviewers can understand your intent. Keeping the description updated is - [Mention refactoring, tests, etc.]
especially important if they didn't participate in the discussion.)
%{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 ## Developer Checklist
to work which are not part of the standard Unicado Package.) - [ ] 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment