From 8f7d5704ee8636af4a9a89d15a3bb238954dc06f Mon Sep 17 00:00:00 2001
From: Kev <cloneofghosts@users.noreply.github.com>
Date: Tue, 19 Nov 2024 18:42:53 -0500
Subject: [PATCH] Add issue/pr templates

---
 .github/ISSUE_TEMPLATE/bug.yml     | 64 ++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml  | 14 +++++++
 .github/ISSUE_TEMPLATE/general.yml | 23 +++++++++++
 .github/PULL_REQUEST_TEMPLATE.md   | 15 +++++++
 4 files changed, 116 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/general.yml
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
new file mode 100644
index 0000000..c9b0613
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,64 @@
+name: Bug Report
+description: Report an issue with the code.
+labels: ["bug" , "Needs Review"]
+body:
+
+  - type: textarea
+    id: describe-the-bug
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is and how to repoduce it.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: |
+        Example:
+          "This happened..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      description: Explain what actually happens.
+      placeholder: |
+        Example:
+          "This happened instead..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: os-details
+    attributes:
+      label: Operating System Information
+    validations:
+      required: true
+
+  - type: textarea
+    id: log-info
+    attributes:
+      label: Log Output
+      description: Include any log output within the code blocks.
+      value: |
+        ```
+
+        ```
+
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Troubleshooting steps
+      description: Before reporting an issue follow these troubleshooting steps to see if it solves the issue.
+      options:
+        - label: This issue is related to the self-hosting code and not an API issue.
+          required: true
+        - label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue.
+          required: true
+        - label: I have written an informative title.
+          required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..550c754
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions
+    url: https://github.com/Pirate-Weather/pirate-weather-code/discussions
+    about: Please ask and answer questions here.
+  - name: API Repository
+    url: https://github.com/Pirate-Weather/pirateweather/
+    about: Report issues with and request features to the API here.
+  - name: Home Assistant Repository
+    url: https://github.com/Pirate-Weather/pirate-weather-ha
+    about: Please report any issues with the Home Assistant integration here.
+  - name: Translations Repository
+    url: https://github.com/Pirate-Weather/translations
+    about: Please report any issues with the translations used in the API here.
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml
new file mode 100644
index 0000000..8716041
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/general.yml
@@ -0,0 +1,23 @@
+name: General Issue
+description: Report an issue which doesn't fit in with any of the other categories.
+labels: ["Needs Review"]
+body:
+
+  - type: textarea
+    id: describe-the-issue
+    attributes:
+      label: Describe the issue
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: acknowledgements
+    attributes:
+      label: Acknowledgements
+      options:
+        - label: This issue is related to the self-hosting code and not an API issue.
+          required: true
+        - label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue.
+          required: true
+        - label: I have written an informative title.
+          required: true
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..2737399
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+## Describe the change
+
+## Type of change
+
+- [ ] Bugfixes to existing code
+- [ ] Breaking change
+- [ ] Code quality improvements to existing code or addition of tests
+- [ ] Documentation Updates
+
+## Checklist
+
+- This pull request fixes issue: fixes #
+- [ ] Code builds locally. **Your pull request won't be merged unless tests pass**
+- [ ] Code has been formatted using ruff
+- [ ] I have signed the CLA agreement
\ No newline at end of file