diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md index abb674b..9485632 100644 --- a/.gitlab/issue_templates/bug.md +++ b/.gitlab/issue_templates/bug.md @@ -1,27 +1,41 @@ -### Summary +/label ~BUG -(Summarize the bug encountered concisely) +### How is it now? + +(What actually happens) + +### How should it be? + +(What you should see instead) ### Steps to reproduce (How one can reproduce the issue - this is very important) -### What is the current *bug* behavior? - -(What actually happens) - -### What is the expected *correct* behavior? - -(What you should see instead) +1. Step 1 +1. Step 2 +1. Step 3 ### Relevant logs and/or screenshots -(Paste any relevant logs - please use code blocks (```) to format console output, +(Paste any relevant logs - please use code blocks to format console output, logs, and code as it's very hard to read otherwise.) ### Possible fixes (If you can, link to the line of code that might be responsible for the problem) -Also please add labels to your bug issue : -/label ~BUG ~Reproduced ~Needs investigation +If you can, give an estimation of the time needed to fix (in hours) +/estimate Xh + +### How to fix a Bug + +1. Ask any question you have in the issue comments before starting +1. Create a new branch named issue-${ISSUE_NUMBER} +1. Write a test that is failing to validate that this bug exists +1. If you can not recreate this bug, feel free to submit just a test with clear name and documentation linking to this issue +1. If a test fails indeed, continue to the next step +1. Now, when you have a regression test ready - create a fix for that bug +1. Write any additional tests if needed +1. Document in docstrings in general documentation what was wrong +1. Submit a merge request diff --git a/.gitlab/issue_templates/feature.md b/.gitlab/issue_templates/feature.md new file mode 100644 index 0000000..6dacc38 --- /dev/null +++ b/.gitlab/issue_templates/feature.md @@ -0,0 +1,27 @@ +## What needs to be done? + +/estimate Xh +/label ~feature + + +## Technical details + +Are there any technical details worth mentioning? + + +## Links + +1. Link to user story in wiki +1. other related Gitlab issues + + +## How to complete + +1. How to complete a Feature +1. Ask any question you have in the issue comments before starting +1. Create a new branch named issue-${ISSUE_NUMBER} +1. Implement a simple test to illustrate the desired functionality +1. Write some code to complete this task +1. Write some additional tests to cover edge cases and some possible errors +1. Write documentation about what have you done and why you have done it this way +1. Submit a merge request diff --git a/.gitlab/issue_templates/feature_proposal.md b/.gitlab/issue_templates/feature_proposal.md deleted file mode 100644 index 8a49715..0000000 --- a/.gitlab/issue_templates/feature_proposal.md +++ /dev/null @@ -1,37 +0,0 @@ -### Problem to solve - - - -### Intended users - - - -### Further details - - - -### Proposal - - - -### Permissions and Security - - - -### Documentation - - - -### Testing - - - -### What does success look like, and how can we measure that? - - - -### Links / references - -/label ~feature diff --git a/.gitlab/merge_request_templates/checklist_before_merging.md b/.gitlab/merge_request_templates/checklist_before_merging.md index eb79fb3..edd506b 100644 --- a/.gitlab/merge_request_templates/checklist_before_merging.md +++ b/.gitlab/merge_request_templates/checklist_before_merging.md @@ -1,13 +1,61 @@ -Please make sure your MR is ready to be merged ! +## Checklist -- [ ] You added the changes in CHANGELOG.md -- [ ] You described the MR as below -- [ ] You updated the [HD APP wiki](https://github.com/recalbox/recalbox-os/wiki/) or the [dev wiki](https://gitlab.com/recalbox/recalbox/wikis/home) + -Fixes #XXX +I have done ... -Changes : -- describe changes here +- [ ] This commits targets only one specific issue +- [ ] The commit message follows our guidelines +- [ ] Tests for the changes have been added +- [ ] Docs have been added or updated +- [ ] I have assigned my architect to review this merge request +- [ ] I have checked how to create a [merge request]() -Related to : -- link other PR or issues here + +## Issues + + + + +## Time spent + + + +/spend Xh + + +## Assignee + + + +/assign + + +## Feedback + + + + +