Merge branch 'master' into patch-1

.github/ISSUE_TEMPLATE/bug.yml → .github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,44 +1,64 @@
-name: Bug Report
+---
+name: "🐛 Bug Report"
 description: Report a bug
-title: "(module name): short issue description"
+title: "(module name): (short issue description)"
 labels: [bug, needs-triage]
+assignees: []
 body:
   - type: textarea
-    id: problem
+    id: description
     attributes:
-      label: What is the problem?
+      label: Describe the bug
+      description: What is the problem? A clear and concise description of the bug.
     validations:
       required: true
-
   - type: textarea
-    id: reproduction
+    id: expected
     attributes:
-      label: Reproduction Steps
+      label: Expected Behavior
       description: |
-        Minimal amount of code that causes the bug (if possible) or a reference.
-
-        The code sample should be an SSCCE. See http://sscce.org/ for details.
-        In short, provide a code sample that we can copy/paste, run and reproduce.
+        What did you expect to happen?
     validations:
       required: true
-
   - type: textarea
-    id: expected
+    id: current
     attributes:
-      label: What did you expect to happen?
+      label: Current Behavior
       description: |
-        What were you trying to achieve by performing the steps above?
+        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: actual
+    id: reproduction
     attributes:
-      label: What actually happened?
+      label: Reproduction Steps
       description: |
-        What is the unexpected behavior you were seeing? If you got an error, paste it here.
+        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: cdk-version
@@ -99,10 +119,3 @@ body:
         e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
     validations:
       required: false
-
-  - type: markdown
-    attributes:
-      value: |
-        ---
-
-        This is :bug: Bug Report

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,6 @@
+---
 blank_issues_enabled: false
 contact_links:
-  - name: Stackoverflow
-    url:  https://stackoverflow.com/questions/tagged/aws-cdk
-    about: Please ask and answer questions here.
+  - name: 💬 General Question
+    url: https://github.com/aws/aws-cdk/discussions/categories/q-a
+    about: Please ask and answer questions as a discussion thread

.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

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,56 +1,59 @@
-name: Feature Request
-description: Request a new feature
-title: "(module name): short issue description"
+---
+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: Description
-      description: Short description of the feature you are proposing.
+      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?
+        Why do you need this feature? For example: "I'm always frustrated when..."
     validations:
-      required: true
-
+        required: true
   - type: textarea
     id: solution
     attributes:
       label: Proposed Solution
       description: |
-        Please include prototype/workaround/sketch/reference implementation.
+        Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
     validations:
-      required: true
-
+      required: false
   - type: textarea
     id: other
     attributes:
-      label: Other information
+      label: Other Information
       description: |
-        e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
+        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: acknowledgments
+    id: ack
     attributes:
-      label: Acknowledge
+      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: markdown
+  - type: input
+    id: sdk-version
     attributes:
-      value: |
-        ---
-
-        This is a :rocket: Feature Request
+      label: CDK version used
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Environment details (OS name and version, etc.)
+    validations:
+        required: true

.github/workflows/issue-label-assign.yml

@@ -3,9 +3,9 @@ on:
  issues:
     types: [opened, edited]
  pull_request:
-    types: [opened, edited]
+    types: [opened]
  pull_request_target:
-    types: [opened, edited]
+    types: [opened]
 
 jobs:
   issue-triage-manager:
@@ -39,7 +39,7 @@ jobs:
           included-labels: "[guidance]"
           default-area: ${{ env.OSDS_DEVS }}
           parameters: >
-            [{"area":"guidance","keywords":["guidance"]}]
+            [{"area":"guidance","keywords":["guidancekeyword"]}]
   pr-triage-manager:
     permissions:
       issues: write
@@ -51,9 +51,11 @@ jobs:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
           target: "pull-requests"
           area-is-keyword: true
-          excluded-labels: "[contribution/core]"
-          parameters: ${{ env.AREA_PARAMS }}
-          affixes: ${{ env.AREA_AFFIXES }}
+          default-area: >
+            {"reviewers":{"teamReviewers":["aws-cdk-owners"]}}
+          parameters: >
+            [{"area":"pullrequests","keywords":["pullrequestkeyword"]}]
+
 
 env:
  OSDS_DEVS: >