Преглед на файлове

Merge pull request #7958 from HJianBo/master

Update the issue templates
JianBo He преди 3 години
родител
ревизия
3847901b3a

+ 0 - 40
.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,40 +0,0 @@
----
-name: Bug Report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!-- 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/assets/issue-handling.png
--->
-
-### Subject of the issue
-Describe your issue here.
-
-### Your environment
-
-For EMQ X 4.3 or newer, please provide the log archive generated by running `node_dump` (The `node_dump` script can be found in `/<path-to-installation-of-emqx>/bin` if you installed emqx from source or zip ball).
-
-- EMQ X version (e.g. `emqx_ctl status`): 
-- 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:
-
-### Steps to reproduce
-Tell us how to reproduce this issue. 
-
-### Expected behaviour
-Tell us what should happen
-
-### Actual behaviour
-Tell us what happens instead
-
-Missing log file can delay the handling of the issue.

+ 82 - 0
.github/ISSUE_TEMPLATE/bug-report.yaml

@@ -0,0 +1,82 @@
+name: Bug Report
+description: Report a bug encountered while running EMQX
+labels: BUG
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What happened?
+      description: |
+        Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner.
+        Our github issue handling flow can be found [issue-handling](https://github.com/emqx/emqx/blob/master/.github/ISSUE_TEMPLATE/assets/issue-handling.png)
+
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: How can we reproduce it (as minimally and precisely as possible)?
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Anything else we need to know?
+
+  - type: textarea
+    id: emqxVersion
+    attributes:
+      label: EMQX version
+      value: |
+        <details>
+
+        ```console
+        $ ./bin/emqx_ctl broker
+        # paste output here
+        ```
+
+        </details>
+    validations:
+      required: true
+
+  - type: textarea
+    id: osVersion
+    attributes:
+      label: OS version
+      value: |
+        <details>
+
+        ```console
+        # On Linux:
+        $ cat /etc/os-release
+        # paste output here
+        $ uname -a
+        # paste output here
+
+        # On Windows:
+        C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture
+        # paste output here
+        ```
+
+        </details>
+
+  - type: textarea
+    id: attachments
+    attributes:
+      label: Log files
+      description: |
+        For EMQX 4.3 or newer, the log and config files archive can be generated by running `node_dump` (The `node_dump` script can be found in `/<path-to-installation-of-emqx>/bin` if you installed emqx from source or zip ball).
+        Before uploading, please make sure that no sensitive information is disclosed in them.
+      value: |
+        <details>
+
+        </details>

+ 7 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Support Request
+    url: https://github.com/emqx/emqx/discussions
+    about: Asking a question about usages, docs or anything you're insterested in
+  - name: Support Request (CN)
+    url: https://askemq.com
+    about: Feel free to visit our Chinese community for support if it is more convenient for you

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

@@ -1,19 +0,0 @@
----
-name: Feature Request
-about: Suggest an idea for this project
-title: ''
-labels: Feature
-assignees: ''
-
----
-
-<!-- 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/assets/issue-handling.png
--->
-
-
-**What would you like to be added/modified**:
-
-**Why is this needed**:

+ 20 - 0
.github/ISSUE_TEMPLATE/feature-request.yaml

@@ -0,0 +1,20 @@
+name: Feature Request
+description: Suggest an idea for this project
+labels: Feature
+body:
+  - type: textarea
+    id: feature
+    attributes:
+      label: What would you like to be added or enhanced?
+      description: |
+        Feature requests are unlikely to make progress as issues.
+        If you have a clear idea about this improvement, you can submit it as a design proposal to [EIP](https://github.com/emqx/eip)
+    validations:
+      required: true
+
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Why is this needed?
+    validations:
+      required: true

+ 0 - 38
.github/ISSUE_TEMPLATE/support-needed.md

@@ -1,38 +0,0 @@
----
-name: Support Needed
-about: Asking a question about usages, docs or anything you're insterested in
-title: ''
-labels: Support
-assignees: ''
-
----
-
-<!-- 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/assets/issue-handling.png
-
-     For support in Chinese, please visit https://askemq.com/
-     中文支持 请访问: https://askemq.com/
--->
-
-### Subject of the support
-Describe your issue here.
-
-Error/Warning printout if any. 
-
-### Your environment
-
-For EMQ X 4.3 or newer, please provide the log archive generated by [node_dump tool](https://github.com/emqx/emqx/blob/master/bin/node_dump) 
-
-Otherwise please provide below info:
-- 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
-
-Missing log file can delay the handling of the issue.