-
Notifications
You must be signed in to change notification settings - Fork 79
Add bug issue templates (#758) #784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| name: General 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 the following crates: | ||
| - [`payjoin-cli`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-cli) | ||
| - [`payjoin-directory`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-directory) | ||
| - [`payjoin-test-utils`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-test-utils) | ||
| - [`payjoin-ffi`](https://github.com/payjoin/rust-payjoin/tree/master/payjoin-ffi) | ||
|
|
||
| ### For bugs relating to the [payjoin](https://github.com/payjoin/rust-payjoin/tree/master/payjoin) crate, [see here](./bug-payjoin-crate.yml). | ||
|
|
||
| ---- | ||
| - 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: dropdown | ||
| attributes: | ||
| label: Which crate is this issue for? | ||
| multiple: false | ||
| options: | ||
| - payjoin-cli | ||
| - payjoin-directory | ||
| - payjoin-test-utils | ||
| - payjoin-ffi | ||
| - type: dropdown | ||
| attributes: | ||
| label: How did you obtain this crate? | ||
| multiple: false | ||
| options: | ||
| - Compiled from source | ||
| - Pre-built binaries | ||
| - Package manager | ||
| - Docker Image | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: features | ||
| attributes: | ||
| label: Features | ||
| description: | | ||
| If you selected "Compiled from source" what features did you use? | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| id: pdk-version | ||
| attributes: | ||
| label: What version of the selected crate are you using? | ||
| description: | ||
| Run `payjoin-cli --version` or `payjoin-directory --version` for the binaries. | ||
| For the library crates (`payjoin-test-utils`, and `payjoin-ffi`), | ||
| check your respective package manager file to see which version you have installed. | ||
| placeholder: e.g. payjoin-0.23.0 or master@ceef77b | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: current-behavior | ||
| attributes: | ||
| label: Current behavior | ||
| description: Tell us what went wrong | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected behavior | ||
| 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. | ||
|
|
||
| Please be aware that the log might contain personally identifying information. | ||
| validations: | ||
| required: false | ||
| - 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| name: payjoin crate bug report | ||
| description: Submit a new bug report for the payjoin crate | ||
| labels: [bug] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## This issue tracker is only for technical issues related to the [payjoin](https://github.com/payjoin/rust-payjoin/tree/master/payjoin) crate. | ||
|
|
||
| ## Bugs for all other crates should [this template](./bug-general.yml). | ||
|
|
||
| ---- | ||
| - 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: checkboxes | ||
| attributes: | ||
| label: Are you using payjoin-ffi? | ||
| options: | ||
| - label: Yes I am | ||
| required: false | ||
| - type: dropdown | ||
| attributes: | ||
| label: If so, which host language? | ||
| multiple: false | ||
| options: | ||
| - python | ||
| - other | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: features | ||
| attributes: | ||
| label: Did you enable any features on the crate? | ||
| description: e.g. `v2` | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| id: pdk-version | ||
| attributes: | ||
| label: What version of the payjoin crate are you using? | ||
| description: Check your respective package manager file to see which version you have installed. | ||
| placeholder: e.g. payjoin-0.23.0 or master@ceef77b | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: current-behavior | ||
| attributes: | ||
| label: Current behavior | ||
| description: Tell us what went wrong | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected behavior | ||
| 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. This can be enabled by prefixing `RUST_LOG=debug cargo run ...` | ||
|
|
||
| Please be aware that the log might contain personally identifying information. | ||
| validations: | ||
| required: false | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My main concern with this is that users might not understand the privacy consequences of certain log messages, maybe it's better to suggest
infoinstead ofdebuguntil we've scrubbed those, and to warn specifically againsttracewhich is not safe?Also the
RUST_LOGsuggestion seems to apply to the tools crates too?Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that suggestion and can modify that in a subsequent PR
I like this idea but not all crates are setup with logs. For example payjoin-directory does not output logs when prefixed this way, its' behavior is unmodified
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, are you sure? trace level outputs are definitely there, there's not many debug level calls though i think only a
serve_payjoin_directoryThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I forgot to say i created #821
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, it appears I was tricked into this by not seeing any output when I used
DEBUG(from this issue). My mistake.