Bläddra i källkod

Update bug_report.md (#2908)

* Update bug_report.md

Added:
1. Actual result, 
2. Suggestions on naming convention
3. CAPSed the system info partially and moved to top. Alternative: use the warning emoji and move outside the commented block
4. Specified few examples of additional context, that might help collecting more info n the bug.

* Update bug_report.md

replaced severity and priority suggestion.

* Update .github/ISSUE_TEMPLATE/bug_report.md

done

Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>

* Update bug_report.md

- Moved actual and expected result together at the top
- Changed to "Alternative scenarios"
- Changed number 4 in additional context as well
-removed duplication of "Steps to reproduce"

Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>
BulatKha 2 år sedan
förälder
incheckning
53cdb68478
1 ändrade filer med 19 tillägg och 11 borttagningar
  1. 19 11
      .github/ISSUE_TEMPLATE/bug_report.md

+ 19 - 11
.github/ISSUE_TEMPLATE/bug_report.md

@@ -15,33 +15,36 @@ https://github.com/provectus/kafka-ui/discussions
 
 
 -->
 -->
 
 
-**Describe the bug**
-<!--(A clear and concise description of what the bug is.)-->
+<!--
+Please follow the naming conventions for bugs:
+<Feature/Area/Scope> :  <Compact, but specific problem summary> 
+Avoid generic titles, like “Topics: incorrect layout of message sorting drop-down list”. Better use something like: “Topics: Message sorting drop-down list overlaps the "Submit" button”.
+
+-->
 
 
+**Describe the bug** (Actual behavior)
+<!--(A clear and concise description of what the bug is.Use a list, if there is more than one problem)-->
+
+**Expected behavior**
+<!--(A clear and concise description of what you expected to happen.)-->
 
 
 **Set up**
 **Set up**
 <!--
 <!--
+WE MIGHT CLOSE THE ISSUE without further explanation IF YOU DON'T PROVIDE THIS INFORMATION.
+
 How do you run the app? Please provide as much info as possible:
 How do you run the app? Please provide as much info as possible:
 1. App version (docker image version or check commit hash in the top left corner in UI)
 1. App version (docker image version or check commit hash in the top left corner in UI)
 2. Helm chart version, if you use one
 2. Helm chart version, if you use one
 3. Any IAAC configs
 3. Any IAAC configs
-
-We might close the issue without further explanation if you don't provide such information.
 -->
 -->
 
 
 
 
 **Steps to Reproduce**
 **Steps to Reproduce**
 <!-- We'd like you to provide an example setup (via docker-compose, helm, etc.) 
 <!-- We'd like you to provide an example setup (via docker-compose, helm, etc.) 
 to reproduce the problem, especially with a complex setups. -->
 to reproduce the problem, especially with a complex setups. -->
-Steps to reproduce the behavior:
 
 
 1. 
 1. 
 
 
-**Expected behavior**
-<!--
-(A clear and concise description of what you expected to happen)
--->
-
 **Screenshots**
 **Screenshots**
 <!--
 <!--
 (If applicable, add screenshots to help explain your problem)
 (If applicable, add screenshots to help explain your problem)
@@ -50,5 +53,10 @@ Steps to reproduce the behavior:
 
 
 **Additional context**
 **Additional context**
 <!--
 <!--
-(Add any other context about the problem here)
+Add any other context about the problem here. E.g.: 
+1. Are there any alternative scenarios (different data/methods/configuration/setup) you have tried? 
+   Were they successfull or same issue occured? Please provide steps as well.
+2. Related issues (if there are any).
+3. Logs (if available)
+4. Is there any serious impact or behaviour on the end-user because of this issue, that can be overlooked?
 -->
 -->