hubl/.gitlab/issue_templates/bug.md

1.1 KiB

/label ~BUG

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)

Step 1 Step 2

Relevant logs and/or screenshots

(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)

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
  2. Create a new branch named issue-${ISSUE_NUMBER}
  3. Write a test that is failing to validate that this bug exists
  4. If you can not recreate this bug, feel free to submit just a test with clear name and documentation linking to this issue
  5. If a test fails indeed, continue to the next step
  6. Now, when you have a regression test ready - create a fix for that bug
  7. Write any additional tests if needed
  8. Document in docstrings in general documentation what was wrong
  9. Submit a merge request