From 62db84491148842889ebb9fa2a6c4ad31e4923d5 Mon Sep 17 00:00:00 2001
From: Steve Myers <steve@notmandatory.org>
Date: Thu, 3 Feb 2022 14:49:25 -0600
Subject: [PATCH] Add Github bug template and issue config and PR template

---
 .github/ISSUE_TEMPLATE/bug_report.yml         | 66 +++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml             |  8 +++
 .../pull_request_template.md                  | 30 +++++++++
 3 files changed, 104 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..e41345a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -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
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..26dcdbc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -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
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
new file mode 100644
index 0000000..6082c70
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -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