hubl/.gitlab/issue_templates/bug.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2019-04-24 15:15:25 +00:00
/label ~BUG
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
### How is it now?
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
(What actually happens)
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
### How should it be?
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
(What you should see instead)
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
### Steps to reproduce
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
(How one can reproduce the issue - this is very important)
2019-04-09 16:20:00 +00:00
2019-04-24 15:15:25 +00:00
Step 1
Step 2
2019-04-09 16:20:00 +00:00
### Relevant logs and/or screenshots
2019-04-24 15:15:25 +00:00
(Paste any relevant logs - please use code blocks to format console output,
2019-04-09 16:20:00 +00:00
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)
2019-04-24 15:15:25 +00:00
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