Skip to content
Snippets Groups Projects
Verified Commit 8806ed7e authored by Daniel Hornung's avatar Daniel Hornung
Browse files

MAINT: Issue and MR templates.

parent 3825de5e
No related branches found
No related tags found
No related merge requests found
Pipeline #33976 passed
## Summary
*Please give a short summary of what the issue is.*
## Expected Behavior
*What did you expect how the software should behave?*
## Actual Behavior
*What did the software actually do?*
## Steps to Reproduce the Problem
*Please describe, step by step, how others can reproduce the problem. Please try these steps for yourself on a clean system.*
1.
2.
3.
## Specifications
- Version: *Which version of this software?*
- Platform: *Which operating system, which other relevant software versions?*
## Possible fixes
*Do you have ideas how the issue can be resolved?*
# Summary # Summary
Insert a meaningful description for this merge request here. What is the *Insert a meaningful description for this merge request here: What is the new/changed behavior?
new/changed behavior? Which bug has been fixed? Are there related Issues? Which bug has been fixed? Are there related issues?*
# Focus # Focus
Point the reviewer to the core of the code change. Where should they start *Point the reviewer to the core of the code change. Where should they start reading? What should
reading? What should they focus on (e.g. security, performance, they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the
maintainability, user-friendliness, compliance with the specs, finding more specs, finding more corner cases, concrete questions)?*
corner cases, concrete questions)?
# Test Environment # Test Environment
How to set up a test environment for manual testing? *How to set up a test environment for manual testing?*
# Check List for the Author # Check List for the Author
Please, prepare your MR for a review. Be sure to write a summary and a Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab
focus and create gitlab comments for the reviewer. They should guide the comments for the reviewer. They should guide the reviewer through the changes, explain your changes
reviewer through the changes, explain your changes and also point out open and also point out open questions. For further good practices have a look at [our review
questions. For further good practices have a look at [our review
guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md)
- [ ] All automated tests pass - [ ] All automated tests pass
- [ ] Reference related Issues - [ ] Reference related issues
- [ ] Up-to-date CHANGELOG.md - [ ] Up-to-date CHANGELOG.md (or not necessary)
- [ ] Appropriate user and developer documentation (or not necessary)
- How do I use the software? Assume "stupid" users.
- How do I develop or debug the software? Assume novice developers.
- [ ] Annotations in code (Gitlab comments) - [ ] Annotations in code (Gitlab comments)
- Intent of new code - Intent of new code
- Problems with old code - Problems with old code
...@@ -33,14 +37,14 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md) ...@@ -33,14 +37,14 @@ guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md)
# Check List for the Reviewer # Check List for the Reviewer
- [ ] I understand the intent of this MR - [ ] I understand the intent of this MR
- [ ] All automated tests pass - [ ] All automated tests pass
- [ ] Up-to-date CHANGELOG.md - [ ] Up-to-date CHANGELOG.md (or not necessary)
- [ ] The test environment setup works and the intended behavior is - [ ] Appropriate user and developer documentation (or not necessary)
reproducible in the test environment - [ ] The test environment setup works and the intended behavior is reproducible in the test
environment
- [ ] In-code documentation and comments are up-to-date. - [ ] In-code documentation and comments are up-to-date.
- [ ] Check: Are there spezifications? Are they satisfied? - [ ] Check: Are there specifications? Are they satisfied?
For further good practices have a look at [our review guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md). For further good practices have a look at [our review guidelines](https://gitlab.com/caosdb/caosdb/-/blob/dev/REVIEW_GUIDELINES.md).
......
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