From 92bbf2cf4099b355bf31ee71ade5f71a9676265b Mon Sep 17 00:00:00 2001 From: Chen Yu Date: Thu, 30 Nov 2023 18:11:38 +0900 Subject: [PATCH] chore: optimize issue template (#2961) * chore: optimize issue template 1. Use GitHub's form feature by default; 2. Update submission rules to lead users to help center; 3. Add a field for ckb light client. * chore: update description of "detail of the issue" Inform users to upload screenshots to demonstrate the issue clearly --- .github/ISSUE_TEMPLATE/bug_report.md | 16 ---- .github/ISSUE_TEMPLATE/bug_report.yml | 77 +++++++++++++++++++ .../ISSUE_TEMPLATE/synchronization-issue.yml | 55 ------------- 3 files changed, 77 insertions(+), 71 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/synchronization-issue.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 31c00758f7..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** (Please enter details, the more detail the better) - - -**Debug info** (Please upload the debug info from `Help` - `Export Debug Information`) - - -**Screenshots** (If applicable, add screenshots to help explain your problem.) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..b5a721c9f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,77 @@ +name: Bug Report +description: Create a report to help us improve Neuron +title: '[Bug Report] **Please describe the bug shortly**' +labels: + - bug +assignees: + - Keith-CY + - yanguoyu +body: + - type: markdown + attributes: + value: | + Please check [Helpe Center](https://neuron.magickbase.com/help-center) first to see if your issue is already addressed. + + - type: dropdown + id: type + validations: + required: true + attributes: + label: Topic Type + options: + - Cannot Synchronize + - Cannot Send Transaction + - Incorrect Balance + - User Experience + - Other + + - type: textarea + id: detial + validations: + required: true + attributes: + label: Detail of the issue + description: Please append detail of the issue here, including steps to reproduce, screenshots, etc. + + - type: markdown + attributes: + value: | + + --- + ## Please add neuron logs if possible, they can be exported by `Menu -> Help -> Export Debug Information` + + + The debug information will be exported as a zip file, you may upload it by drag&drop into **Detail of the issue**, or paste them in the following fields, respectively. + + + - type: textarea + id: bundled-ckb + validations: + required: false + attributes: + label: bundled-ckb.log + render: shell + + - type: textarea + id: bundled-ckb-light-mainnet + validations: + required: false + attributes: + label: bundled-ckb-light-mainnet.log + render: shell + + - type: textarea + id: main-log + validations: + required: false + attributes: + label: main.log + render: shell + + - type: textarea + id: status + validations: + required: false + attributes: + label: status.log + render: shell diff --git a/.github/ISSUE_TEMPLATE/synchronization-issue.yml b/.github/ISSUE_TEMPLATE/synchronization-issue.yml deleted file mode 100644 index 3a44b6ec99..0000000000 --- a/.github/ISSUE_TEMPLATE/synchronization-issue.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: Synchronization issue -description: Neuron doesn't synchronize -title: '[Synchronization] **brief description**' -labels: - - bug -assignees: - - Keith-CY -body: - - type: markdown - attributes: - value: | - Please check if these issues help - - [Synchronization doesnt' start](https://github.com/nervosnetwork/neuron/issues/2388) - - [Transactions keep pending on Neuron v0.101.3](https://github.com/nervosnetwork/neuron/issues/2384) - - [`Check for update` in settings doesn't work](https://github.com/nervosnetwork/neuron/issues/2372) - - - type: textarea - id: detial - validations: - required: true - attributes: - label: Detail of the issue - description: Elaborate on your issue in this field - - - type: markdown - attributes: - value: | - - --- - ## Please add neuron logs if possible, they can be exported by `Menu -> Help -> Export Debug Information` - - - type: textarea - id: bundled-ckb - validations: - required: false - attributes: - label: bundled-ckb.log - render: shell - - - type: textarea - id: main-log - validations: - required: false - attributes: - label: main.log - render: shell - - - type: textarea - id: status - validations: - required: false - attributes: - label: status.log - render: shell -