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:
parent
7f64ff35a4
commit
3d02d54f7f
|
|
@ -1,31 +1,34 @@
|
||||||
name: ":bug: Bug report"
|
name: '🐛 Bug report'
|
||||||
description: Create a report to help us improve
|
description: Create a report to help us improve
|
||||||
title: '[User reported bug]: '
|
title: 'bug: '
|
||||||
labels: C-bug, S-needs-triage
|
labels: [C-bug, S-needs-triage]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
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
|
- type: textarea
|
||||||
id: what-happened
|
id: what-happened
|
||||||
attributes:
|
attributes:
|
||||||
label: What happened?
|
label: What happened?
|
||||||
description: Also tell us, what did you expect to happen?
|
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:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: reproduce
|
id: reproduce
|
||||||
attributes:
|
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.
|
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:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
|
@ -33,15 +36,15 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Zebra logs
|
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.
|
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:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: input
|
- type: input
|
||||||
id: zebrad-version
|
id: zebrad-version
|
||||||
attributes:
|
attributes:
|
||||||
label: Zebra Version
|
label: Zebra Version
|
||||||
description: "For bugs in `zebrad`, run `zebrad --version`."
|
description: 'For bugs in `zebrad`, run `zebrad --version`.'
|
||||||
placeholder: "zebrad 1.0.0-placeholder"
|
placeholder: 'zebrad 1.0.0-placeholder'
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
|
|
@ -58,8 +61,7 @@ body:
|
||||||
id: os-details
|
id: os-details
|
||||||
attributes:
|
attributes:
|
||||||
label: OS details
|
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"
|
description: 'Linux, macOS, BSD: the output of `uname -a`; Windows: version and 32-bit or 64-bit; Other OS: name and version'
|
||||||
placeholder:
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
|
|
||||||
|
|
@ -1,68 +1,67 @@
|
||||||
---
|
---
|
||||||
name: ":octocat: DevOps Report"
|
name: '🚦 DevOps Report'
|
||||||
description: Issues related to the Zebra build, test, or release process.
|
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]
|
labels: [A-devops, C-bug, S-needs-triage]
|
||||||
body:
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for taking the time to report a bug in Zebra!
|
||||||
|
|
||||||
- type: markdown
|
Please fill out the sections below to help us reproduce and fix the bug.
|
||||||
attributes:
|
If you have a question, please ask on [Discord](https://discord.gg/fP2JGmhm) or [GitHub Discussions](https://github.com/ZcashFoundation/zebra/discussions)
|
||||||
value: |
|
- type: textarea
|
||||||
Thank you for taking the time to report a bug in Zebra!
|
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.
|
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
|
||||||
If you have a question, please ask on [Discord](https://discord.gg/fP2JGmhm) or [GitHub Discussions](https://github.com/ZcashFoundation/zebra/discussions)
|
Links to the faulty logs in GitHub Actions or other places are also welcomed.
|
||||||
- type: textarea
|
validations:
|
||||||
id: description
|
required: false
|
||||||
attributes:
|
- type: textarea
|
||||||
label: Describe the issue or request
|
id: solution
|
||||||
description: What is the problem? A clear and concise description of the bug.
|
attributes:
|
||||||
validations:
|
label: Possible Solution
|
||||||
required: true
|
description: |
|
||||||
- type: textarea
|
Suggest a fix/reason for the bug
|
||||||
id: expected
|
validations:
|
||||||
attributes:
|
required: false
|
||||||
label: Expected Behavior
|
- type: textarea
|
||||||
description: |
|
id: context
|
||||||
What did you expect to happen?
|
attributes:
|
||||||
validations:
|
label: Additional Information/Context
|
||||||
required: true
|
description: |
|
||||||
- type: textarea
|
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.
|
||||||
id: current
|
validations:
|
||||||
attributes:
|
required: false
|
||||||
label: Current Behavior
|
- type: input
|
||||||
description: |
|
id: on-prs
|
||||||
What actually happened?
|
attributes:
|
||||||
|
label: Is this happening on PRs?
|
||||||
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
|
validations:
|
||||||
Links to the faulty logs in GitHub Actions or other places are also welcomed.
|
required: false
|
||||||
validations:
|
- type: input
|
||||||
required: true
|
id: on-main
|
||||||
- type: textarea
|
attributes:
|
||||||
id: solution
|
label: Is this happening on the main branch?
|
||||||
attributes:
|
validations:
|
||||||
label: Possible Solution
|
required: false
|
||||||
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
|
|
||||||
|
|
|
||||||
|
|
@ -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?
|
|
||||||
-->
|
|
||||||
|
|
@ -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
|
||||||
|
|
||||||
|
|
@ -1,15 +1,20 @@
|
||||||
---
|
---
|
||||||
name: ":unlock: Private Security Issue"
|
name: '🔓 Private Security Issue'
|
||||||
about: Zebra team use only
|
description: Zebra team use only
|
||||||
title: 'Security Issue #NNN'
|
title: 'Security Issue #NNN'
|
||||||
labels: C-security, S-needs-triage
|
labels: [C-security, S-needs-triage]
|
||||||
assignees: ''
|
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.
|
||||||
## Motivation
|
- type: textarea
|
||||||
|
id: issue
|
||||||
This ticket is a public placeholder for a security issue that the Zebra team is fixing privately.
|
attributes:
|
||||||
The issue number is chosen by our internal tracker, it is not meaningful.
|
label: Description
|
||||||
|
description: |
|
||||||
Zebra developers must discuss the details of this issue using secure channels.
|
Any relevant information about the issue
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
name: ":rocket: Zebra Release"
|
name: "🚀 Zebra Release"
|
||||||
about: 'Zebra team use only'
|
about: 'Zebra team use only'
|
||||||
title: 'Publish next Zebra release: (version)'
|
title: 'Publish next Zebra release: (version)'
|
||||||
labels: 'A-release, C-trivial, P-Medium :zap:'
|
labels: 'A-release, C-trivial, P-Medium :zap:'
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
name: ":clipboard: Usability Testing Plan"
|
name: "📋 Usability Testing Plan"
|
||||||
about: Create a Usability Testing Plan
|
about: Create a Usability Testing Plan
|
||||||
title: 'Usability Testing Plan'
|
title: 'Usability Testing Plan'
|
||||||
labels: C-research
|
labels: C-research
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue