Просмотр исходного кода

chore(github-issue): update issue templates

William Yang 4 лет назад
Родитель
Сommit
ffded5ab30

+ 17 - 4
.github/ISSUE_TEMPLATE/bug-report.md

@@ -8,9 +8,15 @@ labels: "Support, needs-triage"
 
 <!-- Please use this template while reporting a bug and provide as much info as possible. Thanks!-->
 <!-- 请使用英文描述问题 -->
+<!-- Note, lacking of information will delay the handling of issue
+     See our github issue handling flow here:
+     https://github.com/emqx/emqx/blob/master/.github/ISSUE_TEMPLATE/asserts/issue-handling.png
+-->
 
-**Environment**:
+### Subject of the issue
+Describe your issue here.
 
+### Your environment
 - EMQ X version (e.g. `emqx_ctl status`): 
 - Hardware configuration (e.g. `lscpu`):
 - OS (e.g. `cat /etc/os-release`):
@@ -18,8 +24,15 @@ labels: "Support, needs-triage"
 - Erlang/OTP version (in case you build emqx from source code): 
 - Others:
 
-**What happened and what you expected to happen**:
+### Steps to reproduce
+Tell us how to reproduce this issue. 
 
-**How to reproduce it (as minimally and precisely as possible)**:
+It would be great if you can attach the log archive generated by [node_dump tool](https://github.com/emqx/emqx/blob/master/bin/node_dump) 
 
-**Anything else we need to know?**:
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead
+
+Missing log file can delay the handling of the issue.

+ 5 - 0
.github/ISSUE_TEMPLATE/feature-request.md

@@ -7,6 +7,11 @@ labels: "Feature, needs-triage"
 ---
 
 <!-- Please only use this template for submitting enhancement requests -->
+<!-- Note, lacking of information will delay the handling of issue
+     See our github issue handling flow here:
+     https://github.com/emqx/emqx/blob/master/.github/ISSUE_TEMPLATE/asserts/issue-handling.png
+-->
+
 
 **What would you like to be added/modified**:
 

+ 23 - 1
.github/ISSUE_TEMPLATE/support-needed.md

@@ -6,4 +6,26 @@ labels: "Support, needs-triage"
 
 ---
 
-**Please describe your problem in detail, if necessary, you can upload the log file through the attachment**:
+<!-- Note, lacking of information will delay the handling of issue
+     See our github issue handling flow here:
+     https://github.com/emqx/emqx/blob/master/.github/ISSUE_TEMPLATE/asserts/issue-handling.png
+-->
+
+### Subject of the support
+Describe your issue here.
+
+Error/Warning printout if any. 
+
+### Your environment
+- EMQ X version (e.g. `emqx_ctl status`):
+- If cluster (e.g. 3 X 4Core16GB):
+- Hardware configuration (e.g. `lscpu`):
+- OS (e.g. `cat /etc/os-release`):
+- Kernel (e.g. `uname -a`):
+- Erlang/OTP version (in case you build emqx from source code): 
+- Others:
+
+### LOG File
+It would be great if you can attach the log archive generated by [node_dump tool](https://github.com/emqx/emqx/blob/master/bin/node_dump)
+
+Missing log file can delay the handling of the issue.