Skip to content

Commit b9b9948

Browse files
Add Feature Request, Good First Issue, and General Issue Templates (#891)
Followup to #758. Adds the following issue templates mostly from their Bitcoin Core counterparts (excepting the "General" template): - [x] [Feature Request](https://github.com/bitcoin/bitcoin/blob/master/.github/ISSUE_TEMPLATE/feature_request.yml) - [x] [Good First Issue](https://github.com/bitcoin/bitcoin/blob/master/.github/ISSUE_TEMPLATE/good_first_issue.yml) - [x] General
2 parents 7c963c6 + 6b82adb commit b9b9948

File tree

3 files changed

+115
-0
lines changed

3 files changed

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

.github/ISSUE_TEMPLATE/general.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: General Question / Support
2+
description: A general question or support issue that isn't a bug or feature.
3+
body:
4+
- type: dropdown
5+
attributes:
6+
label: Which crate is this feature request for (if any)?
7+
multiple: true
8+
options:
9+
- payjoin
10+
- payjoin-cli
11+
- payjoin-directory
12+
- payjoin-test-utils
13+
- payjoin-ffi
14+
- type: textarea
15+
id: question
16+
attributes:
17+
label: Question
18+
description: Describe the issue
19+
validations:
20+
required: true
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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: dropdown
6+
attributes:
7+
label: Which crate is this issue for?
8+
multiple: true
9+
options:
10+
- payjoin
11+
- payjoin-cli
12+
- payjoin-directory
13+
- payjoin-test-utils
14+
- payjoin-ffi
15+
- type: markdown
16+
attributes:
17+
value: |
18+
Please add the label "good first issue" manually before or after opening
19+
20+
A good first issue is an uncontroversial issue, that has a relatively unique and obvious solution
21+
22+
Motivate the issue and explain the solution briefly
23+
- type: textarea
24+
id: motivation
25+
attributes:
26+
label: Motivation
27+
description: Motivate the issue
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: solution
32+
attributes:
33+
label: Possible solution
34+
description: Describe a possible solution
35+
validations:
36+
required: false
37+
- type: textarea
38+
id: useful-skills
39+
attributes:
40+
label: Useful Skills
41+
description: For example, “Familiarity with BIP 77”.
42+
- type: textarea
43+
attributes:
44+
label: Guidance for new contributors
45+
description: Please leave this to automatically add the footer for new contributors
46+
value: |
47+
Want to work on this issue?
48+
49+
For guidance on contributing, please read [CONTRIBUTING.md](https://github.com/payjoin/rust-payjoin/blob/master/.github/CONTRIBUTING.md) before opening your pull request.

0 commit comments

Comments
 (0)