A proposal for some changes in the template if users start to create issues.
This commit is contained in:
		| @ -13,29 +13,36 @@ | ||||
| (How one can reproduce the issue - this is very important) | ||||
|  | ||||
| 1. Step 1 | ||||
| 1. Step 2 | ||||
| 1. Step 3 | ||||
| 2. Step 2 | ||||
| 3. Step 3 | ||||
|  | ||||
| ### 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.) | ||||
|  | ||||
| ### Severity | ||||
|  | ||||
| (Choose from the following list) | ||||
|  | ||||
| s1: a critical feature is broken: signup, login... | ||||
| s2: a non-critical feature is broken, no workaround | ||||
| s3: a feature is broken but there is a workaround | ||||
| s4: it's annoying, but you can use it or only a few users are impacted | ||||
|  | ||||
| ### Your Environment | ||||
|  | ||||
| (Include relevant details about the environment you experienced the bug in) | ||||
|  | ||||
| * Browser name and version: | ||||
| * Operating System and version (desktop or mobile): | ||||
|  | ||||
| ### Workaround | ||||
|  | ||||
| (Include a workaround for this bug - if relevant) | ||||
|  | ||||
| ### 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 | ||||
| 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 | ||||
|  | ||||
		Reference in New Issue
	
	Block a user