From 3d02d54f7fb277086d47608220dc122ae0106fb9 Mon Sep 17 00:00:00 2001 From: Gustavo Valverde Date: Wed, 19 Jul 2023 00:41:36 +0100 Subject: [PATCH] ref(issues): use newer template where applicable (#7254) * ref(issues): use newer template where applicable This also fixes emojis, indenting and issues with GitHub YAML schema for issues template * fix(issues): do not require testing or related work * fix(issues): textarea required * fix(issues): do not be strict on issues structure --- .github/ISSUE_TEMPLATE/bug_report.yml | 32 ++--- .github/ISSUE_TEMPLATE/devops_report.yml | 123 +++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 43 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 57 ++++++++ .../ISSUE_TEMPLATE/private_security_issue.yml | 29 +++-- .github/ISSUE_TEMPLATE/release.md | 2 +- .../ISSUE_TEMPLATE/usability_testing_plan.md | 2 +- 7 files changed, 154 insertions(+), 134 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 46b71d23..dfb6ef72 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,31 +1,34 @@ -name: ":bug: Bug report" +name: '🐛 Bug report' description: Create a report to help us improve -title: '[User reported bug]: ' -labels: C-bug, S-needs-triage +title: 'bug: ' +labels: [C-bug, S-needs-triage] body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + 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: what-happened attributes: label: What happened? description: Also tell us, what did you expect to happen? - value: "I expected to see this happen: + value: ' + I expected to see this happen: - Instead, this happened: - - " + Instead, this happened: + ' validations: required: true - type: textarea id: reproduce attributes: - label: What were you doing when the issue happened? + label: What were you doing when the issue happened? description: Copy and paste the exact commands or code here. - placeholder: "Behavior or code sample that causes the bug" + placeholder: 'Behavior or code sample that causes the bug' validations: required: false - type: textarea @@ -33,15 +36,15 @@ body: attributes: label: Zebra logs description: Copy and paste the last 100 Zebra log lines or upload the full logs to https://gist.github.com/ and add a link to them here. - placeholder: "Copy and paste the logs here" + placeholder: 'Copy and paste the logs here' validations: required: false - type: input id: zebrad-version attributes: label: Zebra Version - description: "For bugs in `zebrad`, run `zebrad --version`." - placeholder: "zebrad 1.0.0-placeholder" + description: 'For bugs in `zebrad`, run `zebrad --version`.' + placeholder: 'zebrad 1.0.0-placeholder' validations: required: false - type: checkboxes @@ -58,8 +61,7 @@ body: id: os-details attributes: label: OS details - description: "Linux, macOS, BSD: the output of `uname -a`; Windows: version and 32-bit or 64-bit; Other OS: name and version" - placeholder: + description: 'Linux, macOS, BSD: the output of `uname -a`; Windows: version and 32-bit or 64-bit; Other OS: name and version' validations: required: false - type: textarea diff --git a/.github/ISSUE_TEMPLATE/devops_report.yml b/.github/ISSUE_TEMPLATE/devops_report.yml index 9f4ce614..3e5d56fe 100644 --- a/.github/ISSUE_TEMPLATE/devops_report.yml +++ b/.github/ISSUE_TEMPLATE/devops_report.yml @@ -1,68 +1,67 @@ --- -name: ":octocat: DevOps Report" +name: '🚦 DevOps Report' description: Issues related to the Zebra build, test, or release process. -title: "(short issue description)" +title: 'devops: ' 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! -- 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: false + - type: textarea + id: current + attributes: + label: Current Behavior + description: | + What actually happened? - 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 + 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: false + - 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: false + - type: input + id: on-main + attributes: + label: Is this happening on the main branch? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 2ecf68b6..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: ":construction: Change request" -about: Suggest a feature or change for this project -title: '' -labels: C-enhancement, S-needs-triage -assignees: '' - ---- - -## Motivation - - - -### Specifications - - - -### Complex Code or Requirements - - - -### Testing - - - -## Related Work - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..5d400575 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,57 @@ +--- +name: "🚧 Change request" +description: Suggest a feature or change for this project +title: 'feature: ' +labels: [C-enhancement, S-needs-triage] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to suggest a feature or change for Zebra! + + Please fill out the sections below to help us understand your request. + 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: motivation + attributes: + label: Motivation + description: | + Is your feature request related to a problem? + How does this change improve Zebra? + validations: + required: true + - type: textarea + id: specs + attributes: + label: Specifications + description: | + If this change is based on consensus rules, quote them, and link to the Zcash spec or ZIP: https://zips.z.cash/#nu5-zips + If this changes network behaviour, quote and link to the Bitcoin network reference: https://developer.bitcoin.org/reference/p2p_networking.html + validations: + required: false + - type: textarea + id: complexity + attributes: + label: Complex Code or Requirements + description: | + Does this PR change concurrency, unsafe code, or complex consensus rules? + If it does, explain how we will implement, review, and test it. + validations: + required: false + - type: textarea + id: tests + attributes: + label: Testing + description: | + How can we check that this change does what we want it to do? + validations: + required: false + - type: textarea + id: related + attributes: + label: Related Work + description: | + Is this change related to other features or tickets? + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/private_security_issue.yml b/.github/ISSUE_TEMPLATE/private_security_issue.yml index 97e16ab4..82e6e88d 100644 --- a/.github/ISSUE_TEMPLATE/private_security_issue.yml +++ b/.github/ISSUE_TEMPLATE/private_security_issue.yml @@ -1,15 +1,20 @@ --- -name: ":unlock: Private Security Issue" -about: Zebra team use only +name: '🔓 Private Security Issue' +description: Zebra team use only title: 'Security Issue #NNN' -labels: C-security, S-needs-triage -assignees: '' +labels: [C-security, S-needs-triage] +body: + - type: markdown + attributes: + value: | + This ticket is a public placeholder for a security issue that the Zebra team is fixing privately. + The issue number is chosen by our internal tracker, it is not meaningful. ---- - -## Motivation - -This ticket is a public placeholder for a security issue that the Zebra team is fixing privately. -The issue number is chosen by our internal tracker, it is not meaningful. - -Zebra developers must discuss the details of this issue using secure channels. + Zebra developers must discuss the details of this issue using secure channels. + Please do not discuss this issue in public. + - type: textarea + id: issue + attributes: + label: Description + description: | + Any relevant information about the issue diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 05da69d0..fab41907 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -1,5 +1,5 @@ --- -name: ":rocket: Zebra Release" +name: "🚀 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 4c25c394..c93f413b 100644 --- a/.github/ISSUE_TEMPLATE/usability_testing_plan.md +++ b/.github/ISSUE_TEMPLATE/usability_testing_plan.md @@ -1,5 +1,5 @@ --- -name: ":clipboard: Usability Testing Plan" +name: "📋 Usability Testing Plan" about: Create a Usability Testing Plan title: 'Usability Testing Plan' labels: C-research