octo
/
Zebra
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
Gustavo Valverde 2023-07-19 00:41:36 +01:00 committed by GitHub
parent 7f64ff35a4
commit 3d02d54f7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 154 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View File

@ -1,23 +1,26 @@
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:
"
'
validations:
required: true
- type: textarea
@ -25,7 +28,7 @@ body:
attributes:
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

13
.github/ISSUE_TEMPLATE/devops_report.yml vendored
View File

@ -1,10 +1,9 @@
---
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: |
@ -26,7 +25,7 @@ body:
description: |
What did you expect to happen?
validations:
required: true
required: false
- type: textarea
id: current
attributes:
@ -37,7 +36,7 @@ body:
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
required: false
- type: textarea
id: solution
attributes:
@ -59,10 +58,10 @@ body:
attributes:
label: Is this happening on PRs?
validations:
required: true
required: false
- type: input
id: on-main
attributes:
label: Is this happening on the main branch?
validations:
required: true
required: false

43
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -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
<!--
Is your feature request related to a problem?
How does this change improve Zebra?
-->
### Specifications
<!--
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
-->
### Complex Code or Requirements
<!--
Does this PR change concurrency, unsafe code, or complex consensus rules?
If it does, explain how we will implement, review, and test it.
-->
### Testing
<!--
How can we check that this change does what we want it to do?
-->
## Related Work
<!--
Is this change related to other features or tickets?
-->

57
.github/ISSUE_TEMPLATE/feature_request.yml vendored Normal file
View File

@ -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

23
.github/ISSUE_TEMPLATE/private_security_issue.yml vendored
View File

@ -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: ''
---
## Motivation
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.
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

2
.github/ISSUE_TEMPLATE/release.md vendored
View File

@ -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:'

2
.github/ISSUE_TEMPLATE/usability_testing_plan.md vendored
View File

@ -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