Merge branch 'gitlab_issue_templates' into 'master'
Gitlab issue templates See merge request startinblox/applications/sib-app!24
This commit is contained in:
Patrick L
commit
095fbc968a
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
### Problem to solve
|
||||
|
||||
<!-- What problem do we solve? -->
|
||||
|
||||
### Intended users
|
||||
|
||||
<!-- Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later.
|
||||
Personas can be found at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ -->
|
||||
|
||||
### Further details
|
||||
|
||||
<!-- Include use cases, benefits, and/or goals (contributes to our vision?) -->
|
||||
|
||||
### Proposal
|
||||
|
||||
<!-- How are we going to solve the problem? Try to include the user journey! https://about.gitlab.com/handbook/journeys/#user-journey -->
|
||||
|
||||
### Permissions and Security
|
||||
|
||||
<!-- What permissions are required to perform the described actions? Are they consistent with the existing permissions as documented for users, groups, and projects as appropriate? Is the proposed behavior consistent between the UI, API, and other access methods (e.g. email replies)? -->
|
||||
|
||||
### Documentation
|
||||
|
||||
<!-- See the Feature Change Documentation Workflow https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html
|
||||
Add all known Documentation Requirements here, per https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html#documentation-requirements -->
|
||||
|
||||
### Testing
|
||||
|
||||
<!-- What risks does this change pose? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing? See the test engineering process for further guidelines: https://about.gitlab.com/handbook/engineering/quality/guidelines/test-engineering/ -->
|
||||
|
||||
### What does success look like, and how can we measure that?
|
||||
|
||||
<!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. -->
|
||||
|
||||
### Links / references
|
||||
|
||||
/label ~feature
|
||||
|
|
@ -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)
|
||||
<!---
|
||||
Please, make sure you have changed the topic and also
|
||||
described briefly what have you done. Thanks!
|
||||
-->
|
||||
|
||||
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
|
||||
|
||||
<!---
|
||||
Which issue this PR closes? It can close only one issue.
|
||||
Which issues this PR references?
|
||||
Please, specify all issues.
|
||||
Format is: Closes #X or Refs #Y
|
||||
Docs: https://docs.gitlab.com/ee/user/project/issues/closing_issues.html#via-merge-request
|
||||
-->
|
||||
|
||||
|
||||
## Time spent
|
||||
|
||||
<!---
|
||||
This information is only required for statistics and analysis.
|
||||
But we need to know exactly how much time you have spent,
|
||||
please try to be as accurate as possible.
|
||||
Format is: /spend 1h
|
||||
Docs: https://docs.gitlab.com/ee/workflow/time_tracking.html
|
||||
-->
|
||||
|
||||
/spend Xh
|
||||
|
||||
|
||||
## Assignee
|
||||
|
||||
<!---
|
||||
You need to assign your architect to review your merge request.
|
||||
Format: /assign @username
|
||||
Docs: https://docs.gitlab.com/ee/user/project/quick_actions.html
|
||||
-->
|
||||
|
||||
/assign
|
||||
|
||||
|
||||
## Feedback
|
||||
|
||||
<!---
|
||||
Did you encounter any other problems you want to share with us?
|
||||
Optional. Feel free to remove this section if you don't have any feedback.
|
||||
-->
|
||||
|
||||
|
||||
<!--- Thank you for you contribution! -->
|
||||
|
|
|
|||
Loading…
Reference in New Issue