From e6d3295b8a7add859e9d65fcbe165156880be3ca Mon Sep 17 00:00:00 2001 From: Gustavo Valverde Date: Tue, 18 Jul 2023 08:20:57 +0100 Subject: [PATCH] refactor(issues): Include DevOps template and improve others (#7232) * add(issues): add DevOps ticket template * imp(issues): add visual feedback and context * fix: use correct links * fix(issues): typo * fix: typo * fix(issues): wrong file type * fix(issues): yaml error --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 9 ++- .github/ISSUE_TEMPLATE/devops_report.yml | 68 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .../ISSUE_TEMPLATE/private_security_issue.yml | 2 +- .github/ISSUE_TEMPLATE/release.md | 2 +- .../ISSUE_TEMPLATE/usability_testing_plan.md | 2 +- 7 files changed, 81 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/devops_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f3bf463a..46b71d23 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: Bug report +name: ":bug: Bug report" description: Create a report to help us improve title: '[User reported bug]: ' labels: C-bug, S-needs-triage diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0086358d..e1816836 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false +contact_links: + - name: 💬 Zcash Community Support + url: https://forum.zcashcommunity.com/ + about: You're invited to ask questions about the ecosystem, community and Zebra + - name: ❓ General Questions about Zebra + url: https://github.com/ZcashFoundation/zebra/discussions/categories/q-a + about: Please ask and answer questions about Zebra as a discussion threads diff --git a/.github/ISSUE_TEMPLATE/devops_report.yml b/.github/ISSUE_TEMPLATE/devops_report.yml new file mode 100644 index 00000000..9f4ce614 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/devops_report.yml @@ -0,0 +1,68 @@ +--- +name: ":octocat: DevOps Report" +description: Issues related to the Zebra build, test, or release process. +title: "(short issue description)" +labels: [A-devops, C-bug, S-needs-triage] +body: + +- type: markdown + attributes: + value: | + Thank you for taking the time to report a bug in Zebra! + + Please fill out the sections below to help us reproduce and fix the bug. + If you have a question, please ask on [Discord](https://discord.gg/fP2JGmhm) or [GitHub Discussions](https://github.com/ZcashFoundation/zebra/discussions) +- type: textarea + id: description + attributes: + label: Describe the issue or request + description: What is the problem? A clear and concise description of the bug. + validations: + required: true +- type: textarea + id: expected + attributes: + label: Expected Behavior + description: | + What did you expect to happen? + validations: + required: true +- type: textarea + id: current + attributes: + label: Current Behavior + description: | + What actually happened? + + Please include full errors, uncaught exceptions, stack traces, and relevant logs. + Links to the faulty logs in GitHub Actions or other places are also welcomed. + validations: + required: true +- type: textarea + id: solution + attributes: + label: Possible Solution + description: | + Suggest a fix/reason for the bug + validations: + required: false +- type: textarea + id: context + attributes: + label: Additional Information/Context + description: | + Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful for the community. + validations: + required: false +- type: input + id: on-prs + attributes: + label: Is this happening on PRs? + validations: + required: true +- type: input + id: on-main + attributes: + label: Is this happening on the main branch? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9ac8226f..2ecf68b6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,5 @@ --- -name: Change request +name: ":construction: Change request" about: Suggest a feature or change for this project title: '' labels: C-enhancement, S-needs-triage diff --git a/.github/ISSUE_TEMPLATE/private_security_issue.yml b/.github/ISSUE_TEMPLATE/private_security_issue.yml index ffd7e691..97e16ab4 100644 --- a/.github/ISSUE_TEMPLATE/private_security_issue.yml +++ b/.github/ISSUE_TEMPLATE/private_security_issue.yml @@ -1,5 +1,5 @@ --- -name: Private Security Issue +name: ":unlock: Private Security Issue" about: Zebra team use only title: 'Security Issue #NNN' labels: C-security, S-needs-triage diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index af1a6833..05da69d0 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -1,5 +1,5 @@ --- -name: 'Zebra Release' +name: ":rocket: Zebra Release" about: 'Zebra team use only' title: 'Publish next Zebra release: (version)' labels: 'A-release, C-trivial, P-Medium :zap:' diff --git a/.github/ISSUE_TEMPLATE/usability_testing_plan.md b/.github/ISSUE_TEMPLATE/usability_testing_plan.md index 16b333eb..4c25c394 100644 --- a/.github/ISSUE_TEMPLATE/usability_testing_plan.md +++ b/.github/ISSUE_TEMPLATE/usability_testing_plan.md @@ -1,5 +1,5 @@ --- -name: Usability Testing Plan +name: ":clipboard: Usability Testing Plan" about: Create a Usability Testing Plan title: 'Usability Testing Plan' labels: C-research