Skip to content

Commit 5678a18

Browse files
Add bug issue templates (payjoin#758)
Copied and made modifications to Bitcoin Core's [bug](https://github.com/bitcoin/bitcoin/blob/master/.github/ISSUE_TEMPLATE/bug.yml) issue template where appropriate initially. At @nothingmuch's suggestion, split this into two issue templates: - `bug-payjoin-crate.yml`, for issues relating to the `payjoin` crate - `bug-general.yml` for all other issues for other crates The former focuses on knowing whether the user is using FFI, includes a dropdown for language choice, asks what feature flags are enabled, etc. The latter focuses more on how they obtained it (binary, compiled from source, etc.) and information about the environment.
1 parent ceef77b commit 5678a18

File tree

2 files changed

+187
-0
lines changed

2 files changed

+187
-0
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: General 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 the following crates:
9+
- [`payjoin-cli`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-cli)
10+
- [`payjoin-directory`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-directory)
11+
- [`payjoin-test-utils`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-test-utils)
12+
- [`payjoin-ffi`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-ffi)
13+
14+
### For bugs relating to the [payjoin](https://github.com/payjoin/rust-payjoin/tree/master/payjoin) crate, [see here](./bug-payjoin-crate.yml).
15+
16+
----
17+
- type: checkboxes
18+
attributes:
19+
label: Is there an existing issue for this?
20+
description: Please search to see if an issue already exists for the bug you encountered.
21+
options:
22+
- label: I have searched the existing issues
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: Which crate is this issue for?
27+
multiple: false
28+
options:
29+
- payjoin-cli
30+
- payjoin-directory
31+
- payjoin-test-utils
32+
- payjoin-ffi
33+
- type: dropdown
34+
attributes:
35+
label: How did you obtain this crate?
36+
multiple: false
37+
options:
38+
- Compiled from source
39+
- Pre-built binaries
40+
- Package manager
41+
- Docker Image
42+
- Other
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: features
47+
attributes:
48+
label: Features
49+
description: |
50+
If you selected "Compiled from source" what features did you use?
51+
validations:
52+
required: false
53+
- type: input
54+
id: pdk-version
55+
attributes:
56+
label: What version of the selected crate are you using?
57+
description:
58+
Run `payjoin-cli --version` or `payjoin-directory --version` for the binaries.
59+
For the library crates (`payjoin-test-utils`, and `payjoin-ffi`),
60+
check your respective package manager file to see which version you have installed.
61+
placeholder: e.g. payjoin-0.23.0 or master@ceef77b
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: current-behavior
66+
attributes:
67+
label: Current behavior
68+
description: Tell us what went wrong
69+
validations:
70+
required: true
71+
- type: textarea
72+
id: expected-behavior
73+
attributes:
74+
label: Expected behavior
75+
description: Tell us what you expected to happen
76+
validations:
77+
required: true
78+
- type: textarea
79+
id: reproduction-steps
80+
attributes:
81+
label: Steps to reproduce
82+
description: |
83+
Tell us how to reproduce your bug. Please attach related screenshots if necessary.
84+
* Run-time or compile-time configuration options
85+
* Actions taken
86+
validations:
87+
required: true
88+
- type: textarea
89+
id: logs
90+
attributes:
91+
label: Relevant log output
92+
description: |
93+
Please copy and paste any relevant log output.
94+
95+
Please be aware that the log might contain personally identifying information.
96+
validations:
97+
required: false
98+
- type: input
99+
id: os
100+
attributes:
101+
label: Operating system and version
102+
placeholder: e.g. "MacOS Ventura 13.2" or "Ubuntu 22.04 LTS"
103+
validations:
104+
required: true
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: payjoin crate bug report
2+
description: Submit a new bug report for the payjoin crate
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## This issue tracker is only for technical issues related to the [payjoin](https://github.com/payjoin/rust-payjoin/tree/master/payjoin) crate.
9+
10+
## Bugs for all other crates should [this template](./bug-general.yml).
11+
12+
----
13+
- type: checkboxes
14+
attributes:
15+
label: Is there an existing issue for this?
16+
description: Please search to see if an issue already exists for the bug you encountered.
17+
options:
18+
- label: I have searched the existing issues
19+
required: true
20+
- type: checkboxes
21+
attributes:
22+
label: Are you using payjoin-ffi?
23+
options:
24+
- label: Yes I am
25+
required: false
26+
- type: dropdown
27+
attributes:
28+
label: If so, which host language?
29+
multiple: false
30+
options:
31+
- python
32+
- other
33+
validations:
34+
required: false
35+
- type: textarea
36+
id: features
37+
attributes:
38+
label: Did you enable any features on the crate?
39+
description: e.g. `v2`
40+
validations:
41+
required: false
42+
- type: input
43+
id: pdk-version
44+
attributes:
45+
label: What version of the payjoin crate are you using?
46+
description: Check your respective package manager file to see which version you have installed.
47+
placeholder: e.g. payjoin-0.23.0 or master@ceef77b
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: current-behavior
52+
attributes:
53+
label: Current behavior
54+
description: Tell us what went wrong
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: expected-behavior
59+
attributes:
60+
label: Expected behavior
61+
description: Tell us what you expected to happen
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: reproduction-steps
66+
attributes:
67+
label: Steps to reproduce
68+
description: |
69+
Tell us how to reproduce your bug. Please attach related screenshots if necessary.
70+
* Run-time or compile-time configuration options
71+
* Actions taken
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: logs
76+
attributes:
77+
label: Relevant log output
78+
description: |
79+
Please copy and paste any relevant log output. This can be enabled by prefixing `RUST_LOG=debug cargo run ...`
80+
81+
Please be aware that the log might contain personally identifying information.
82+
validations:
83+
required: false

0 commit comments

Comments
 (0)