Skip to content

Commit 3fa1185

Browse files
willcl-arkwillcl-ark
committed
github: Switch to yaml issue templates
These provide more flexibility and can be designed to extract more information from users when submitting issues.
1 parent aaa5597 commit 3fa1185

File tree

10 files changed

+197
-121
lines changed

10 files changed

+197
-121
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Bug report
2+
description: Submit a new bug report.
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## This issue tracker is only for technical issues related to Bitcoin Core.
9+
10+
* General bitcoin questions and/or support requests should use Bitcoin StackExchange at https://bitcoin.stackexchange.com.
11+
* For reporting security issues, please read instructions at https://bitcoincore.org/en/contact/.
12+
* 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.
13+
14+
----
15+
- type: checkboxes
16+
attributes:
17+
label: Is there an existing issue for this?
18+
description: Please search to see if an issue already exists for the bug you encountered.
19+
options:
20+
- label: I have searched the existing issues
21+
required: true
22+
- type: textarea
23+
id: current-behaviour
24+
attributes:
25+
label: Current behaviour
26+
description: Tell us what went wrong
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: expected-behaviour
31+
attributes:
32+
label: Expected behaviour
33+
description: Tell us what you expected to happen
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: reproduction-steps
38+
attributes:
39+
label: Steps to reproduce
40+
description: |
41+
Tell us how to reproduce your bug. Please attach related screenshots if necessary.
42+
* Run-time or compile-time configuration options
43+
* Actions taken
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: logs
48+
attributes:
49+
label: Relevant log output
50+
description: |
51+
Please copy and paste any relevant log output or attach a debug log file.
52+
53+
You can find the debug.log in your [data dir.](https://github.com/bitcoin/bitcoin/blob/master/doc/files.md#data-directory-location)
54+
55+
Please be aware that the debug log might contain personally identifying information.
56+
validations:
57+
required: false
58+
- type: dropdown
59+
attributes:
60+
label: How did you obtain Bitcoin Core
61+
multiple: false
62+
options:
63+
- Compiled from source
64+
- Pre-built binaries
65+
- Package manager
66+
- Other
67+
validations:
68+
required: true
69+
- type: input
70+
id: core-version
71+
attributes:
72+
label: What version of Bitcoin Core are you using?
73+
description: Run `bitcoind --version` or in Bitcoin-QT use `Help > About Bitcoin Core`
74+
placeholder: e.g. v24.0.1 or master@e1bf547
75+
validations:
76+
required: true
77+
- type: input
78+
id: os
79+
attributes:
80+
label: Operating system and version
81+
placeholder: e.g. "MacOS Ventura 13.2" or "Ubuntu 22.04 LTS"
82+
validations:
83+
required: true
84+
- type: textarea
85+
id: machine-specs
86+
attributes:
87+
label: Machine specifications
88+
description: |
89+
What are the specifications of the host machine?
90+
e.g. OS/CPU and disk type, network connectivity
91+
validations:
92+
required: false
93+

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Bitcoin Core Security Policy
4+
url: https://github.com/bitcoin/bitcoin/blob/master/SECURITY.md
5+
about: View security policy
6+
- name: Bitcoin Core Developers
7+
url: https://bitcoincore.org
8+
about: Bitcoin Core homepage

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project.
3+
labels: [Feature]
4+
body:
5+
- type: textarea
6+
id: feature
7+
attributes:
8+
label: Please describe the feature you'd like to see added.
9+
description: Attach screenshots or logs if applicable.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: related-problem
14+
attributes:
15+
label: Is your feature related to a problem, if so please describe it.
16+
description: Attach screenshots or logs if applicable.
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: solution
21+
attributes:
22+
label: Describe the solution you'd like
23+
validations:
24+
required: false
25+
- type: textarea
26+
id: alternatives
27+
attributes:
28+
label: Describe any alternatives you've considered
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: additional-context
33+
attributes:
34+
label: Please leave any additional context
35+
validations:
36+
required: false

‎.github/ISSUE_TEMPLATE/good_first_issue.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/good_first_issue.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Good First Issue
2+
description: (Regular devs only) Suggest a new good first issue
3+
labels: [good first issue]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please add the label "good first issue" manually before or after opening
9+
10+
A good first issue is an uncontroversial issue, that has a relatively unique and obvious solution
11+
12+
Motivate the issue and explain the solution briefly
13+
- type: textarea
14+
id: motivation
15+
attributes:
16+
label: Motivation
17+
description: Motivate the issue
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Possible solution
24+
description: Describe a possible solution
25+
validations:
26+
required: false
27+
- type: textarea
28+
id: useful-skills
29+
attributes:
30+
label: Useful Skills
31+
description: For example, “`std::thread`”, “Qt5 GUI and async GUI design” or “basic understanding of Bitcoin mining and the Bitcoin Core RPC interface”.
32+
validations:
33+
required: false
34+
- type: textarea
35+
attributes:
36+
label: Guidance for new contributors
37+
description: Please leave this to automatically add the footer for new contributors
38+
value: |
39+
Want to work on this issue?
40+
41+
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/gui_issue.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/gui_issue.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Issue or feature request related to the GUI
2+
description: Any report, issue or feature request related to the GUI
3+
labels: [GUI]
4+
body:
5+
- type: checkboxes
6+
id: acknowledgement
7+
attributes:
8+
label: Issues, reports or feature requests related to the GUI should be opened directly on the GUI repo
9+
description: https://github.com/bitcoin-core/gui/issues/
10+
options:
11+
- label: I still think this issue should be opened here
12+
required: true
13+
- type: textarea
14+
id: gui-request
15+
attributes:
16+
label: Report
17+
validations:
18+
required: true

0 commit comments

Comments
 (0)