mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-03-05 14:06:27 -05:00
github: Switch to yaml issue templates
These provide more flexibility and can be designed to extract more information from users when submitting issues.
This commit is contained in:
parent
aaa55971f6
commit
3fa1185dda
10 changed files with 197 additions and 121 deletions
27
.github/ISSUE_TEMPLATE.md
vendored
27
.github/ISSUE_TEMPLATE.md
vendored
|
@ -1,27 +0,0 @@
|
||||||
<!-- This issue tracker is only for technical issues related to Bitcoin Core.
|
|
||||||
|
|
||||||
General bitcoin questions and/or support requests are best directed to the Bitcoin StackExchange at https://bitcoin.stackexchange.com.
|
|
||||||
|
|
||||||
For reporting security issues, please read instructions at https://bitcoincore.org/en/contact/.
|
|
||||||
|
|
||||||
If the node is "stuck" during sync or giving "block checksum mismatch" errors, please ensure your hardware is stable by running memtest and observe CPU temperature with a load-test tool such as linpack before creating an issue!
|
|
||||||
|
|
||||||
Any report, issue or feature request related to the GUI should be reported at
|
|
||||||
https://github.com/bitcoin-core/gui/issues/
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Describe the issue -->
|
|
||||||
<!--- What behavior did you expect? -->
|
|
||||||
|
|
||||||
<!--- What was the actual behavior (provide screenshots if the issue is GUI-related)? -->
|
|
||||||
|
|
||||||
<!--- How reliably can you reproduce the issue, what are the steps to do so? -->
|
|
||||||
|
|
||||||
<!-- What version of Bitcoin Core are you using, where did you get it (website, self-compiled, etc)? -->
|
|
||||||
|
|
||||||
<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
|
|
||||||
|
|
||||||
<!-- GUI-related issue? What is your operating system and its version? If Linux, what is your desktop environment and graphical shell? -->
|
|
||||||
|
|
||||||
<!-- Any extra information that might be useful in the debugging process. -->
|
|
||||||
<!--- This is normally the contents of a `debug.log` or `config.log` file. Raw text or a link to a pastebin type site are preferred. -->
|
|
93
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
93
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
|
@ -0,0 +1,93 @@
|
||||||
|
name: Bug report
|
||||||
|
description: Submit a new bug report.
|
||||||
|
labels: [bug]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
## This issue tracker is only for technical issues related to Bitcoin Core.
|
||||||
|
|
||||||
|
* General bitcoin questions and/or support requests should use Bitcoin StackExchange at https://bitcoin.stackexchange.com.
|
||||||
|
* For reporting security issues, please read instructions at https://bitcoincore.org/en/contact/.
|
||||||
|
* If the node is "stuck" during sync or giving "block checksum mismatch" errors, please ensure your hardware is stable by running `memtest` and observe CPU temperature with a load-test tool such as `linpack` before creating an issue.
|
||||||
|
|
||||||
|
----
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please search to see if an issue already exists for the bug you encountered.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: current-behaviour
|
||||||
|
attributes:
|
||||||
|
label: Current behaviour
|
||||||
|
description: Tell us what went wrong
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behaviour
|
||||||
|
attributes:
|
||||||
|
label: Expected behaviour
|
||||||
|
description: Tell us what you expected to happen
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction-steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: |
|
||||||
|
Tell us how to reproduce your bug. Please attach related screenshots if necessary.
|
||||||
|
* Run-time or compile-time configuration options
|
||||||
|
* Actions taken
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Relevant log output
|
||||||
|
description: |
|
||||||
|
Please copy and paste any relevant log output or attach a debug log file.
|
||||||
|
|
||||||
|
You can find the debug.log in your [data dir.](https://github.com/bitcoin/bitcoin/blob/master/doc/files.md#data-directory-location)
|
||||||
|
|
||||||
|
Please be aware that the debug log might contain personally identifying information.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: How did you obtain Bitcoin Core
|
||||||
|
multiple: false
|
||||||
|
options:
|
||||||
|
- Compiled from source
|
||||||
|
- Pre-built binaries
|
||||||
|
- Package manager
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: core-version
|
||||||
|
attributes:
|
||||||
|
label: What version of Bitcoin Core are you using?
|
||||||
|
description: Run `bitcoind --version` or in Bitcoin-QT use `Help > About Bitcoin Core`
|
||||||
|
placeholder: e.g. v24.0.1 or master@e1bf547
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating system and version
|
||||||
|
placeholder: e.g. "MacOS Ventura 13.2" or "Ubuntu 22.04 LTS"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: machine-specs
|
||||||
|
attributes:
|
||||||
|
label: Machine specifications
|
||||||
|
description: |
|
||||||
|
What are the specifications of the host machine?
|
||||||
|
e.g. OS/CPU and disk type, network connectivity
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
41
.github/ISSUE_TEMPLATE/bug_report.md
vendored
41
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,41 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve (use this for suspected bugs only, if not sure, open a regular issue below)
|
|
||||||
title: ''
|
|
||||||
labels: Bug
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- This issue tracker is only for technical issues related to Bitcoin Core.
|
|
||||||
|
|
||||||
General bitcoin questions and/or support requests are best directed to the Bitcoin StackExchange at https://bitcoin.stackexchange.com.
|
|
||||||
|
|
||||||
For reporting security issues, please read instructions at https://bitcoincore.org/en/contact/.
|
|
||||||
|
|
||||||
If the node is "stuck" during sync or giving "block checksum mismatch" errors, please ensure your hardware is stable by running memtest and observe CPU temperature with a load-test tool such as linpack before creating an issue! -->
|
|
||||||
|
|
||||||
<!-- Describe the issue -->
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
|
|
||||||
<!--- What behavior did you expect? -->
|
|
||||||
|
|
||||||
**Actual behavior**
|
|
||||||
|
|
||||||
<!--- What was the actual behavior (provide screenshots if the issue is GUI-related)? -->
|
|
||||||
|
|
||||||
**To reproduce**
|
|
||||||
|
|
||||||
<!--- How reliably can you reproduce the issue, what are the steps to do so? -->
|
|
||||||
|
|
||||||
**System information**
|
|
||||||
|
|
||||||
<!-- What version of Bitcoin Core are you using, where did you get it (website, self-compiled, etc)? -->
|
|
||||||
|
|
||||||
<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
|
|
||||||
|
|
||||||
<!-- GUI-related issue? What is your operating system and its version? If Linux, what is your desktop environment and graphical shell? -->
|
|
||||||
|
|
||||||
<!-- Any extra information that might be useful in the debugging process. -->
|
|
||||||
<!--- This is normally the contents of a `debug.log` or `config.log` file. Raw text or a link to a pastebin type site are preferred. -->
|
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Bitcoin Core Security Policy
|
||||||
|
url: https://github.com/bitcoin/bitcoin/blob/master/SECURITY.md
|
||||||
|
about: View security policy
|
||||||
|
- name: Bitcoin Core Developers
|
||||||
|
url: https://bitcoincore.org
|
||||||
|
about: Bitcoin Core homepage
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
name: Feature request
|
|
||||||
about: Suggest an idea for this project
|
|
||||||
title: ''
|
|
||||||
labels: Feature
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
|
||||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
|
||||||
<!-- A clear and concise description of what you want to happen. -->
|
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
|
||||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
<!-- Add any other context or screenshots about the feature request here. -->
|
|
36
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
36
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
name: Feature Request
|
||||||
|
description: Suggest an idea for this project.
|
||||||
|
labels: [Feature]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: feature
|
||||||
|
attributes:
|
||||||
|
label: Please describe the feature you'd like to see added.
|
||||||
|
description: Attach screenshots or logs if applicable.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: related-problem
|
||||||
|
attributes:
|
||||||
|
label: Is your feature related to a problem, if so please describe it.
|
||||||
|
description: Attach screenshots or logs if applicable.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Describe the solution you'd like
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Describe any alternatives you've considered
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: Please leave any additional context
|
||||||
|
validations:
|
||||||
|
required: false
|
22
.github/ISSUE_TEMPLATE/good_first_issue.md
vendored
22
.github/ISSUE_TEMPLATE/good_first_issue.md
vendored
|
@ -1,22 +0,0 @@
|
||||||
---
|
|
||||||
name: Good first issue
|
|
||||||
about: '(Regular devs only): Suggest a new good first issue'
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Needs the label "good first issue" assigned manually before or after opening -->
|
|
||||||
|
|
||||||
<!-- A good first issue is an uncontroversial issue, that has a relatively unique and obvious solution -->
|
|
||||||
|
|
||||||
<!-- Motivate the issue and explain the solution briefly -->
|
|
||||||
|
|
||||||
#### Useful skills:
|
|
||||||
|
|
||||||
<!-- (For example, “std::thread”, “Qt5 GUI and async GUI design” or “basic understanding of Bitcoin mining and the Bitcoin Core RPC interface”.) -->
|
|
||||||
|
|
||||||
#### Want to work on this issue?
|
|
||||||
|
|
||||||
For guidance on contributing, please read [CONTRIBUTING.md](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md) before opening your pull request.
|
|
42
.github/ISSUE_TEMPLATE/good_first_issue.yml
vendored
Normal file
42
.github/ISSUE_TEMPLATE/good_first_issue.yml
vendored
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
name: Good First Issue
|
||||||
|
description: (Regular devs only) Suggest a new good first issue
|
||||||
|
labels: [good first issue]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Please add the label "good first issue" manually before or after opening
|
||||||
|
|
||||||
|
A good first issue is an uncontroversial issue, that has a relatively unique and obvious solution
|
||||||
|
|
||||||
|
Motivate the issue and explain the solution briefly
|
||||||
|
- type: textarea
|
||||||
|
id: motivation
|
||||||
|
attributes:
|
||||||
|
label: Motivation
|
||||||
|
description: Motivate the issue
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Possible solution
|
||||||
|
description: Describe a possible solution
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: useful-skills
|
||||||
|
attributes:
|
||||||
|
label: Useful Skills
|
||||||
|
description: For example, “`std::thread`”, “Qt5 GUI and async GUI design” or “basic understanding of Bitcoin mining and the Bitcoin Core RPC interface”.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Guidance for new contributors
|
||||||
|
description: Please leave this to automatically add the footer for new contributors
|
||||||
|
value: |
|
||||||
|
Want to work on this issue?
|
||||||
|
|
||||||
|
For guidance on contributing, please read [CONTRIBUTING.md](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md) before opening your pull request.
|
||||||
|
|
11
.github/ISSUE_TEMPLATE/gui_issue.md
vendored
11
.github/ISSUE_TEMPLATE/gui_issue.md
vendored
|
@ -1,11 +0,0 @@
|
||||||
---
|
|
||||||
name: An issue or feature request related to the GUI
|
|
||||||
about: Any report, issue or feature request related to the GUI should be reported at https://github.com/bitcoin-core/gui/issues/
|
|
||||||
title: Any report, issue or feature request related to the GUI should be reported at https://github.com/bitcoin-core/gui/issues/
|
|
||||||
labels: GUI
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Any report, issue or feature request related to the GUI should be reported at
|
|
||||||
https://github.com/bitcoin-core/gui/issues/
|
|
18
.github/ISSUE_TEMPLATE/gui_issue.yml
vendored
Normal file
18
.github/ISSUE_TEMPLATE/gui_issue.yml
vendored
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
name: Issue or feature request related to the GUI
|
||||||
|
description: Any report, issue or feature request related to the GUI
|
||||||
|
labels: [GUI]
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
id: acknowledgement
|
||||||
|
attributes:
|
||||||
|
label: Issues, reports or feature requests related to the GUI should be opened directly on the GUI repo
|
||||||
|
description: https://github.com/bitcoin-core/gui/issues/
|
||||||
|
options:
|
||||||
|
- label: I still think this issue should be opened here
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: gui-request
|
||||||
|
attributes:
|
||||||
|
label: Report
|
||||||
|
validations:
|
||||||
|
required: true
|
Loading…
Add table
Reference in a new issue