Add Github bug template and issue config and PR template

This commit is contained in:
Steve Myers 2022-02-03 14:49:25 -06:00
parent 9bb629d0a8
commit 62db844911
No known key found for this signature in database
GPG Key ID: 8105A46B22C2D051
3 changed files with 104 additions and 0 deletions

66
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,66 @@
name: Bug Report
description: Create a report to help us improve
labels: [ "bug", "triage" ]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Description
description: A concise description of the bug, what happened?
placeholder: What did you see...
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: How to Reproduce
description: Steps or code to reproduce the behavior.
placeholder: How can we can reproduce it...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Result
description: What did you expected to happen.
placeholder: Tell us what you were expecting...
validations:
required: true
- type: textarea
id: version
attributes:
label: Version
description: Which release version(s), commit, or branch of code do you see this bug?
placeholder: Tell us which version(s) of code you saw the bug in...
validations:
required: true
- type: checkboxes
id: artifact
attributes:
label: Artifact
description: With which artifact(s) are you seeing this bug?
options:
- label: bdk-jvm
- label: bdk-android
- type: checkboxes
id: platform
attributes:
label: Platform
description: What target platform(s) are you seeing the problem on?
options:
- label: ARM64 Android
- label: 64-bit x86 Android
- label: 32-bit x86 Android
- label: 64-bit x86 Linux (kernel 2.6.32+, glibc 2.11+)
- label: 64-bit x86 macOS (10.7+, Lion+)
- label: ARM64 macOS (11.0+, Big Sur+)
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 📝 Official Documentation
url: https://bitcoindevkit.org/getting-started/
about: Check our documentation for answers to common questions
- name: 💬 Community Chat
url: https://discord.com/invite/dstn4dQ
about: Ask general questions and get community support in real-time

View File

@ -0,0 +1,30 @@
<!-- Erase any parts of this template not applicable to your Pull Request. -->
### Description
<!-- Describe the purpose of this PR, what's being adding and/or fixed -->
### Notes to the reviewers
<!-- In this section you can include notes directed to the reviewers, like explaining why some parts
of the PR were done in a specific way -->
### Checklists
#### All Submissions:
* [ ] I've signed all my commits
* [ ] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
* [ ] I ran `cargo fmt` and `cargo clippy` before committing
#### New Features:
* [ ] I've added tests for the new feature
* [ ] I've added docs for the new feature
* [ ] I've updated `CHANGELOG.md`
#### Bugfixes:
* [ ] This pull request breaks the existing API
* [ ] I've added tests to reproduce the issue which are now passing
* [ ] I'm linking the issue being fixed by this PR