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

Add issue and MR template

parent 2fa57684
No related branches found
No related tags found
2 merge requests!6Initial open source version,!3Renamed PW1127_JM_mod to PW1127_JM
This commit is part of merge request !3. Comments created here will be created in the context of that merge request.
<!-- 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.
<!-- 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"
<!-- 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"
<!-- 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"
<!-- 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment