From e61064faf8ded03bf650702fb24a94f77a6d85f2 Mon Sep 17 00:00:00 2001 From: Umair Sarfraz Date: Wed, 20 Apr 2022 15:51:19 +0200 Subject: [PATCH] chore: update task & bug report template --- .github/ISSUE_TEMPLATE/bug-report.yml | 84 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 45 ------------ .github/ISSUE_TEMPLATE/config.yml | 12 +++- .github/ISSUE_TEMPLATE/create-task.yml | 50 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 28 -------- 5 files changed, 143 insertions(+), 76 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/create-task.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..2fa96f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,84 @@ +--- +name: Found a bug? +description: Fill in this form to report it, and help us improve +title: '[Bug]: ' +labels: type:bug report + +body: + - type: markdown + attributes: + value: '## Reporting a bug' + - type: markdown + attributes: + value: | + Thank you for helping us make node-dashboard better, by reporting a bug you have found. This issue may already be reported! Please join our [discord](https://discord.iota.org/) for help. + + - type: textarea + id: description + attributes: + label: Issue description + description: Briefly describe the issue. + validations: + required: true + + - type: textarea + id: expected_behaviour + attributes: + label: Expected behaviour + description: A concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: actual_behaviour + attributes: + label: Actual behaviour + description: A concise description of what actually happened. + validations: + required: true + + - type: dropdown + id: can_repro + attributes: + label: Can the issue reliably be reproduced? + options: + - 'Yes' + - 'No' + validations: + required: true + + - type: textarea + id: repro_steps + attributes: + label: Steps to reproduce the issue + description: Explain how the maintainer can reproduce the issue. + placeholder: | + 1. + 2. + 3. + ... + + - type: textarea + id: errors + attributes: + label: Errors + description: Paste any errors (or screenshots). + render: shell + + - type: checkboxes + id: duplicate_declaration + attributes: + label: Duplicate declaration + description: Please confirm that you are not creating a duplicate issue. + options: + - label: I have searched the issues tracker for this issue and there is none + required: true + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/iotaledger/node-dashboard/blob/main/.github/CODE_OF_CONDUCT.md). + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8f4e999..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Report a bug in the Node Dashboard -about: Create a report to help us improve -title: "" -labels: bug ---- - -## Bug description - -Briefly describe the bug. - -## Node.js version - -Which version of Node.js are you running? - -- Node.js version: - -## Hardware specification - -What hardware are you using? - -- Operating system: -- RAM: -- Cores: -- Device: - -## Steps To reproduce the bug - -Explain how the maintainer can reproduce the bug. - -1. -2. -3. - -## Expected behaviour - -Describe what you expect to happen. - -## Actual behaviour - -Describe what actually happens. - -## Errors - -Paste any errors that you see, including logs, errors, or screenshots. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 596e17a..ad29efc 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,14 @@ blank_issues_enabled: false contact_links: + - name: Request a feature + url: https://github.com/iotaledger/node-dashboard/discussions/categories/features-enhancements + about: Propose a feature or enhancement in GitHub discussions + - name: Security vulnerabilities + url: security@iota.org + about: Please report security vulnerabilities here. + - name: General feedback + url: https://github.com/iotaledger/node-dashboard/discussions/categories/feedback + about: Leave us some feedback - name: Discord url: https://discord.iota.org/ about: Please ask and answer questions here. - - name: Security vulnerabilities - url: security@iota.org - about: Please report security vulnerabilities here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/create-task.yml b/.github/ISSUE_TEMPLATE/create-task.yml new file mode 100644 index 0000000..8df1cdb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/create-task.yml @@ -0,0 +1,50 @@ +--- +name: New task +description: Create a new work task +title: '[Task]: ' + +body: + - type: markdown + attributes: + value: '## Creating a task' + - type: markdown + attributes: + value: | + This form should be used by official maintainers only to create new work tasks. Most tasks should be assigned to a milestone and the task management project. + + - type: textarea + id: description + attributes: + label: Task description + description: Describe the task that needs to be completed. + validations: + required: true + + - type: textarea + id: requirements + attributes: + label: Requirements + description: What are the requirements for this task, this could be a checklist of subtasks. + validations: + required: true + + - type: textarea + id: acceptance_criteria + attributes: + label: Acceptance criteria + description: What is the criteria for this task to be marked as done? This will help anyone approving any PRs related to this task. + validations: + required: true + + - type: checkboxes + id: checklist + attributes: + label: Creation checklist + description: 'Before submitting this task please ensure you have done the following if necessary:' + options: + - label: I have assigned this task to the correct people + required: false + - label: I have added the most appropriate labels + required: false + - label: I have linked the correct milestone and/or project + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index fbd8d0f..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Request a feature for the Node Dashboard -about: Request a feature ---- - -## Description - -Briefly describe the feature that you are requesting. - -## Motivation - -Explain why this feature is needed. - -## Requirements - -Write a list of what you want this feature to do. - -1. -2. -3. - -## Open questions (optional) - -Use this section to ask any questions that are related to the feature. - -## Are you planning to do it yourself in a pull request? - -Yes/No.