From 742078330ac4ee090bc3642bc9ed6a043f7cbb4f Mon Sep 17 00:00:00 2001
From: Greg Dennis <gregsdennis@yahoo.com>
Date: Fri, 21 Jun 2024 10:10:48 +1200
Subject: [PATCH] update issue and pr templates

---
 .github/ISSUE_TEMPLATE.md                |  2 --
 .github/ISSUE_TEMPLATE/clarification.yml | 33 ++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/proposal.yml      | 29 +++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md         | 28 +++++++++++++++++++-
 4 files changed, 89 insertions(+), 3 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/clarification.yml
 create mode 100644 .github/ISSUE_TEMPLATE/proposal.yml

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 9ea9e2fb..00000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,2 +0,0 @@
-<!-- Love json-schema? Please consider supporting our collective:
-👉  https://opencollective.com/json-schema/donate -->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/clarification.yml b/.github/ISSUE_TEMPLATE/clarification.yml
new file mode 100644
index 00000000..22530974
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/clarification.yml
@@ -0,0 +1,33 @@
+name: 🧹 Clarification Needed
+description: Something in the specification is unclear
+title: "🧹 Clarification: "
+labels: ["🧹 Clarification", "Status: Triage"]
+body:
+- type: textarea
+  attributes:
+    label: Specification section
+    description:  Which specification document needs clarification?  Which section?
+    placeholder: |
+      [Core | Validation], Section: ? 
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: What is unclear?
+    description: Please quote the current text and explain why it's unclear.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Proposal
+    description: Do you have an idea to make the text more clear?
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy)
+    options:
+      - 'Yes'
+      - 'No'
+  validations:
+    required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml
new file mode 100644
index 00000000..a4947178
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/proposal.yml
@@ -0,0 +1,29 @@
+name: ⭐️ Proposal
+description: Suggest an idea for a new feature
+title: "✨ Proposal: "
+labels: ["proposal", "Status: Triage"]
+body:
+- type: textarea
+  attributes:
+    label: Describe the inspiration for your proposal
+    description: Does the proposal address a problem you're facing?
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe the proposal
+    description: Please be as clear as possible and use examples.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe alternatives you've considered
+    description: Can the functionality you're proposal be achieved with the features available today?
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional context
+    description: Is there anything else related to your proposal that you'd like to cover?
+  validations:
+    required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9ea9e2fb..48ecff5b 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,2 +1,28 @@
 <!-- Love json-schema? Please consider supporting our collective:
-👉  https://opencollective.com/json-schema/donate -->
\ No newline at end of file
+👉  https://opencollective.com/json-schema/donate -->
+
+<!-- In order to keep off topic discussion to a minimum, it helps if the "work to be done" is already agreed on. -->
+<!-- Ideally, a GitHub Issue with the label `Status: Consensus` will have been concluded, and linked to in this PR. -->
+
+<!--
+Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.
+-->
+
+### What kind of change does this PR introduce?
+
+<!-- E.g. a bugfix, feature, refactoring, etc… -->
+
+### Issue & Discussion References
+
+<!-- Pick at least one of the below options, and remove those which don't apply. -->
+-  Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
+-  Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
+-  Others? <!-- Add any additional notes or references here -->
+
+### Summary
+
+<!-- Explain the motivation for making this change. What existing problem does the pull request solve? -->
+
+### Does this PR introduce a breaking change?
+
+<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->