diff --git a/.github/ISSUE_TEMPLATE/assets/issue-handling.png b/.github/ISSUE_TEMPLATE/assets/issue-handling.png new file mode 100644 index 000000000..d78d79e2b Binary files /dev/null and b/.github/ISSUE_TEMPLATE/assets/issue-handling.png differ diff --git a/.github/ISSUE_TEMPLATE/assets/issue-handling.uml b/.github/ISSUE_TEMPLATE/assets/issue-handling.uml new file mode 100644 index 000000000..d8fca7f95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/assets/issue-handling.uml @@ -0,0 +1,70 @@ +@startuml + +new: tag "#needs-triage" + +new_waiting: untag '#needs-triage' +new_waiting: tag '#triage/wait' +new_waiting --> accepted: pass 2nd review + +accepted: auto tag '#triage/accepted' +accepted: untag '#needs-triage' +accepted: issue is ready to be worked on +accepted: in backlog, need planning + +assigned: update type tag (#support | #bug | #feature) +assigned: tag '#triage/accepted' +assigned: untag '#new, new_waiting' +assigned: update assignee +assigned: update priority + +InProgress: Update with link to the PR +InProgress: Update release tag +InProgress: Patch testing with issue reporter + +needs_information: tag '#triage/needs-information', notify reporter + +stale: untag '#triage/wait' +stale: tag '#stale' and notify reporter + +closed: github close issue +closed: converted to discussion + +[*]--> new: created + +new --> accepted: pass 1st review +new --> closed: If the issue is a topic \nfor discussion(not for bug or support) +new --> new_waiting: lack of info + +new_waiting --> stale: 7 days no updates +stale ---> closed: 14 days no updates +stale ---> new_waiting: updated info +closed --> [*] + +accepted -down--> assigned: priority review + +accepted --> needs_information: need more information\n to proceeed +needs_information --> accepted: updates +assigned --> InProgress: In sprint run\n or\n start to work on +InProgress --> closed: issue is solved +InProgress --->InProgress: More info is required from issuer reporter +needs_information -----> stale: no updates \n after 14 days + +note left of new_waiting + next review: 5 days +end note + +note right of accepted + using priority tag + - #priority/critical-urgent + - #priority/important-soon + - #priority/important-longterm + - #priority/backlog + - #priority/awaiting-more-evidence + using area tag + - #area/lb + - #area/acl + - #area/config + ... +end note + +@enduml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 3ec513a37..825992ce8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -2,14 +2,23 @@ name: Bug Report about: Create a report to help us improve title: '' -labels: "Support, needs-triage" +labels: needs-triage --- + -**Environment**: +### Subject of the issue +Describe your issue here. + +### 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) - EMQ X version (e.g. `emqx_ctl status`): - Hardware configuration (e.g. `lscpu`): @@ -18,8 +27,13 @@ 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)**: +### Expected behaviour +Tell us what should happen -**Anything else we need to know?**: +### Actual behaviour +Tell us what happens instead + +Missing log file can delay the handling of the issue. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 1fb5f401f..2f55bcfb8 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,6 +7,11 @@ labels: "Feature, needs-triage" --- + + **What would you like to be added/modified**: diff --git a/.github/ISSUE_TEMPLATE/support-needed.md b/.github/ISSUE_TEMPLATE/support-needed.md index a19299c42..49ba5a913 100644 --- a/.github/ISSUE_TEMPLATE/support-needed.md +++ b/.github/ISSUE_TEMPLATE/support-needed.md @@ -6,4 +6,29 @@ labels: "Support, needs-triage" --- -**Please describe your problem in detail, if necessary, you can upload the log file through the attachment**: + + +### 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.