From 70981455eac1468c1ac98ea92378b98297a0e293 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Mon, 16 May 2022 10:42:21 +0800 Subject: [PATCH 1/3] chore: update issue template --- .github/ISSUE_TEMPLATE/bug-report.md | 40 ---------- .github/ISSUE_TEMPLATE/bug-report.yaml | 81 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 19 ----- .github/ISSUE_TEMPLATE/feature-request.yaml | 17 +++++ .github/ISSUE_TEMPLATE/support-needed.md | 38 ---------- .github/ISSUE_TEMPLATE/support-needed.yaml | 4 + 6 files changed, 102 insertions(+), 97 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/support-needed.md create mode 100644 .github/ISSUE_TEMPLATE/support-needed.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 09e473659..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug Report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - - - - - -### 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 `//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. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..05f62280e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,81 @@ +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. + See our github issue handling flow here: 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: | +
+ + ```console + $ ./bin/emqx broker + # paste output here + ``` + +
+ validations: + required: true + + - type: textarea + id: osVersion + attributes: + label: OS version + value: | +
+ + ```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 + ``` + +
+ + - type: textarea + id: attachments + attributes: + label: Log files + description: | + For EMQ X 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 `//bin` if you installed emqx from source or zip ball). + value: | +
+ +
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 0fc9c1f75..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for this project -title: '' -labels: Feature -assignees: '' - ---- - - - - - -**What would you like to be added/modified**: - -**Why is this needed**: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 000000000..2c30c62d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,17 @@ +name: Feature Request Issue +description: Suggest an idea for this project +labels: Feature +body: + - type: textarea + id: feature + attributes: + label: What would you like to be added/modified? + validations: + required: true + + - type: textarea + id: rationale + attributes: + label: Why is this needed? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/support-needed.md b/.github/ISSUE_TEMPLATE/support-needed.md deleted file mode 100644 index 0e8ee9089..000000000 --- a/.github/ISSUE_TEMPLATE/support-needed.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Support Needed -about: Asking a question about usages, docs or anything you're insterested in -title: '' -labels: Support -assignees: '' - ---- - - - -### 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. diff --git a/.github/ISSUE_TEMPLATE/support-needed.yaml b/.github/ISSUE_TEMPLATE/support-needed.yaml new file mode 100644 index 000000000..d48932796 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support-needed.yaml @@ -0,0 +1,4 @@ +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 From 1ec111ad2e05de67626a25058e1e6b6677a63c6e Mon Sep 17 00:00:00 2001 From: JianBo He Date: Mon, 16 May 2022 10:54:00 +0800 Subject: [PATCH 2/3] chore: update issue-template config.yml --- .github/ISSUE_TEMPLATE/bug-report.yaml | 7 ++++--- .github/ISSUE_TEMPLATE/config.yml | 7 +++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 4 ++-- .github/ISSUE_TEMPLATE/support-needed.yaml | 4 ---- 4 files changed, 13 insertions(+), 9 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/support-needed.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 05f62280e..61f7afb6d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -8,7 +8,7 @@ body: 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. - See our github issue handling flow here: https://github.com/emqx/emqx/blob/master/.github/ISSUE_TEMPLATE/assets/issue-handling.png + 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 @@ -40,7 +40,7 @@ body:
```console - $ ./bin/emqx broker + $ ./bin/emqx_ctl broker # paste output here ``` @@ -74,7 +74,8 @@ body: attributes: label: Log files description: | - For EMQ X 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 `//bin` if you installed emqx from source or zip ball). + 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 `//bin` if you installed emqx from source or zip ball). + Before uploading, please make sure that no sensitive information is disclosed in them. value: |
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..c699d69af --- /dev/null +++ b/.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. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 2c30c62d7..2e1ff3f75 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -1,11 +1,11 @@ -name: Feature Request Issue +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/modified? + label: What would you like to be added or enhanced? validations: required: true diff --git a/.github/ISSUE_TEMPLATE/support-needed.yaml b/.github/ISSUE_TEMPLATE/support-needed.yaml deleted file mode 100644 index d48932796..000000000 --- a/.github/ISSUE_TEMPLATE/support-needed.yaml +++ /dev/null @@ -1,4 +0,0 @@ -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 From ee9560718bfdeac730083eadabc9e648dcc6d3c5 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Mon, 16 May 2022 11:53:13 +0800 Subject: [PATCH 3/3] chore: add description for feature-request --- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature-request.yaml | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c699d69af..ee81beb75 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +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. + 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. + about: Feel free to visit our Chinese community for support if it is more convenient for you diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 2e1ff3f75..fd8d19d7e 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -6,6 +6,9 @@ body: 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