From b191f60630d513449c6771de38d2d7fcbc8d7941 Mon Sep 17 00:00:00 2001
From: kellertk <kellertk@amazon.com>
Date: Thu, 31 Mar 2022 15:14:18 -0700
Subject: [PATCH] feat: Standardize issue template for discussions

---
 .github/ISSUE_TEMPLATE/1-bug.md             | 50 --------------
 .github/ISSUE_TEMPLATE/2-feature-request.md | 49 --------------
 .github/ISSUE_TEMPLATE/3-guidance.md        | 41 ------------
 .github/ISSUE_TEMPLATE/bug-report.yml       | 73 +++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml           |  6 ++
 .github/ISSUE_TEMPLATE/documentation.yml    | 23 +++++++
 .github/ISSUE_TEMPLATE/feature-request.yml  | 59 +++++++++++++++++
 7 files changed, 161 insertions(+), 140 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/1-bug.md
 delete mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.md
 delete mode 100644 .github/ISSUE_TEMPLATE/3-guidance.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml

diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md
deleted file mode 100644
index 0ee6e7806e..0000000000
--- a/.github/ISSUE_TEMPLATE/1-bug.md
+++ /dev/null
@@ -1,50 +0,0 @@
----
-name: "\U0001F41B Bug Report"
-about: Report a bug
-labels: bug, needs-triage
----
-
-## :bug: Bug Report
-
-### Affected Languages
-<!--
-Check the box (with an X) for any language runtime that you know is affected by
-the reported bug. If you're uncertain whether a language is affected or not,
-please leave the bux un-checked.
--->
-- [ ] `TypeScript` or `Javascript`
-- [ ] `Python`
-- [ ] `Java`
-- [ ] .NET (`C#`, `F#`, ...)
-- [ ] `Go`
-
-### General Information
-* **JSII Version:** <!-- Output of `jsii --version` -->
-* **Platform:**     <!-- `uname -a` (UNIX) / Version of Windows -->
-
-### What is the problem?
-<!--
-Describe in as much detail as possible the problem that you have identified.
-Whenever possible, add reference to the minimal reproduction of the issue, as
-this will greatly help with identifying the root cause of the problem, and
-ensuring a candidate fix is working.
-
-If your minimal reprodiction is large, you may provide references to a [gist][1]
-or any other publicly viewable location.
--->
-
-### Verbose Log
-<!--
-* If your issue is with `jsii`: please provide the output of running `jsii` with
-  the `--verbose` option.
-* If your issue is with `jsii-pacmak`: please provide the output of running
-  `jsii-pacmak` with the `--verbose` option.
-* If your issue is when running generated code: please provide the output of
-  running your program with the `JSII_DEBUG=1` environment variable being set.
-
-If the output is very large, you may store it in a [gist][1]. In any case,
-please review the contents of the log you are about to submit and edit any
-confidential information out.
-
-[1]: https://gist.github.com
--->
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
deleted file mode 100644
index b1b1221ea7..0000000000
--- a/.github/ISSUE_TEMPLATE/2-feature-request.md
+++ /dev/null
@@ -1,49 +0,0 @@
----
-name: "\U0001F680 Feature Request"
-about: Request a new feature
-labels: feature-request, needs-triage
----
-
-## :rocket: Feature Request
-
-### Affected Languages
-<!--
-Check the box (with an X) for any language runtime that you know is affected by
-the reported bug. If you're uncertain whether a language is affected or not,
-please leave the box un-checked.
--->
-- [ ] `TypeScript` or `Javascript`
-- [ ] `Python`
-- [ ] `Java`
-- [ ] .NET (`C#`, `F#`, ...)
-- [ ] `Go`
-
-### General Information
-* **JSII Version:** <!-- Output of `jsii --version` -->
-* **Platform:**     <!-- `uname -a` (UNIX) / Version of Windows -->
-<!--
-Check the box below (with an X) if you are able and willing to propose an
-implementation for the requested feature. This does not imply a commitment from
-you to actually do it!
--->
-* [ ] I may be able to implement this feature request
-<!--
-Check the box below (with an X) if you think this feature might result in a
-breaking change (this requiring a major version bump when released). If unsure,
-please leave the box un-checked.
--->
-* [ ] This feature might incur a breaking change
-
-### Description
-<!--
-Describe the feature you would like added in as much detail as you can. Make
-sure you explain how it'll enhance the project, user-experience or feature set.
--->
-
-### Proposed Solution
-<!--
-Whenever relevant, describe how you would like the feature to be implemented.
-Include any documentation that can help understand your idea in very concrete
-ways, such as code examples that leverage your feature, captures of design
-diagrams, ...
--->
diff --git a/.github/ISSUE_TEMPLATE/3-guidance.md b/.github/ISSUE_TEMPLATE/3-guidance.md
deleted file mode 100644
index 263485b119..0000000000
--- a/.github/ISSUE_TEMPLATE/3-guidance.md
+++ /dev/null
@@ -1,41 +0,0 @@
----
-name: "\U00002753 Guidance"
-about: Ask a general guidance
-labels: guidance, needs-triage
----
-
-## :question: Guidance
-
-<!--
-⚠️ Important Information
-Please make sure you have gone through the [existing questions][1] before filing
-a new issue! If your question was already asked, but the answer does not satisfy
-your curiosity, prefer re-opening the existing issue to ask for further
-clarification, instead of filing a new issue.
-
-[1]: https://github.com/aws/jsii/issues?utf8=✓&q=is%3Aissue+label%3Aguidance
--->
-
-### Affected Languages
-<!--
-Check the box (with an X) for any language runtime that you know is affected by
-the reported bug. If you're uncertain whether a language is affected or not,
-please leave the bux un-checked.
--->
-- [ ] `TypeScript` or `Javascript`
-- [ ] `Python`
-- [ ] `Java`
-- [ ] .NET (`C#`, `F#`, ...)
-- [ ] `Go`
-
-### General Information
-* **JSII Version:** <!-- Output of `jsii --version` -->
-* **Platform:**     <!-- `uname -a` (UNIX) / Version of Windows -->
-
-### The Question
-<!--
-Ask your question here. Include any details relevant. Make sure you are not
-falling prey to the [X/Y problem][2]!
-
-[2]: http://xyproblem.info
--->
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 0000000000..7dbaee37a3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,73 @@
+---
+name: "🐛 Bug Report"
+description: Report a bug
+title: "(short issue description)"
+labels: [bug, needs-triage]
+assignees: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: What is the problem? A clear and concise description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: |
+        What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: current
+    attributes:
+      label: Current Behavior
+      description: |
+        What actually happened?
+        
+        Please include full errors, uncaught exceptions, stack traces, and relevant logs.
+        If service responses are relevant, please include wire logs.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction Steps
+      description: |
+        Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
+        For more complex issues provide a repo with the smallest sample that reproduces the bug.
+        
+        Avoid including business logic or unrelated code, it makes diagnosis more difficult.
+        The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Possible Solution
+      description: |
+        Suggest a fix/reason for the bug
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Information/Context
+      description: |
+        Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
+    validations:
+      required: false
+  - type: input
+    id: sdk-version
+    attributes:
+      label: SDK version used
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Environment details (OS name and version, etc.)
+    validations:
+        required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..3811bfb3f1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,6 @@
+---
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 General Question
+    url: https://github.com/aws/jsii/discussions/categories/q-a
+    about: Please ask and answer questions as a discussion thread
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
new file mode 100644
index 0000000000..c068514d13
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -0,0 +1,23 @@
+---
+name: "📕 Documentation Issue"
+description: Report an issue in the API Reference documentation or Developer Guide
+title: "(short issue description)"
+labels: [documentation, needs-triage]
+assignees: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the issue
+      description: A clear and concise description of the issue.
+    validations:
+      required: true
+
+  - type: textarea
+    id: links
+    attributes:
+      label: Links
+      description: |
+        Include links to affected documentation page(s).
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
new file mode 100644
index 0000000000..23c385d1ef
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,59 @@
+---
+name: 🚀 Feature Request
+description: Suggest an idea for this project
+title: "(short issue description)"
+labels: [feature-request, needs-triage]
+assignees: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature
+      description: A clear and concise description of the feature you are proposing.
+    validations:
+      required: true
+  - type: textarea
+    id: use-case
+    attributes:
+      label: Use Case
+      description: |
+        Why do you need this feature? For example: "I'm always frustrated when..."
+    validations:
+        required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: |
+        Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
+    validations:
+      required: false
+  - type: textarea
+    id: other
+    attributes:
+      label: Other Information
+      description: |
+        Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
+    validations:
+      required: false
+  - type: checkboxes
+    id: ack
+    attributes:
+      label: Acknowledgements
+      options:
+        - label: I may be able to implement this feature request
+          required: false
+        - label: This feature might incur a breaking change
+          required: false
+  - type: input
+    id: sdk-version
+    attributes:
+      label: CDK version used
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Environment details (OS name and version, etc.)
+    validations:
+        required: true