Skip to content

Commit

Permalink
docs(GitHub issue templates): Upgrade to GitHub Issues v2 (#16592)
Browse files Browse the repository at this point in the history
## Summary

This PR updates this repo's GitHub issue templates to v2. ([see prototype](https:/ryparker/proto-github-issues-v2/issues/new/choose)) 

**Reviewers**: Please make sure that all the fields i've marked with `required: true` are necessary. A user will not be able to create an issue without these required fields being completed.

[GitHub issues v2 docs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)

<kbd>

<img width="1278" alt="CleanShot 2021-09-21 at 18 37 06@2x" src="https://user-images.githubusercontent.com/17558268/134269803-f5dda15c-6bdc-4c63-ac3e-65a3f1626246.png">

</kbd>

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
ryparker authored and njlynch committed Oct 11, 2021
1 parent f2de15b commit a3d6a5e
Show file tree
Hide file tree
Showing 11 changed files with 359 additions and 266 deletions.
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

108 changes: 108 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
name: Bug Report
description: Report a bug
title: "(module name): short issue description"
labels: [bug, needs-triage]
body:
- type: textarea
id: problem
attributes:
label: What is the problem?
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction Steps
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.
validations:
required: true

- type: textarea
id: expected
attributes:
label: What did you expect to happen?
description: |
What were you trying to achieve by performing the steps above?
validations:
required: true

- type: textarea
id: actual
attributes:
label: What actually happened?
description: |
What is the unexpected behavior you were seeing? If you got an error, paste it here.
validations:
required: true

- type: input
id: cdk-version
attributes:
label: CDK CLI Version
description: Output of `cdk version`
validations:
required: true

- type: input
id: framework-version
attributes:
label: Framework Version
validations:
required: false

- type: input
id: node-version
attributes:
label: Node.js Version
validations:
required: true

- type: input
id: operating-system
attributes:
label: OS
validations:
required: true

- type: dropdown
id: language
attributes:
label: Language
multiple: true
options:
- Typescript
- Python
- .NET
- Java
- Go
validations:
required: true

- type: input
id: language-version
attributes:
label: Language Version
description: E.g. TypeScript (3.8.3) | Java (8) | Python (3.7.3)
validations:
required: false

- type: textarea
id: other
attributes:
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
validations:
required: false

- type: markdown
attributes:
value: |
---
This is :bug: Bug Report
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/doc.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Documentation Issue
description: Issue in the reference documentation or developer guide
title: "(module name): short issue description"
labels: [feature-request, documentation, needs-triage]
body:
- type: markdown
attributes:
value: |
Developer guide? Raise issue/pr here: https:/awsdocs/aws-cdk-guide
Want to help? Submit a pull request here: https:/aws/aws-cdk
- type: input
id: doc-link
attributes:
label: link to reference doc page
validations:
required: false

- type: textarea
id: issue
attributes:
label: Describe your issue?
validations:
required: true

- type: markdown
attributes:
value: |
---
This is a 📕 documentation issue
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature Request
description: Request a new feature
title: "(module name): short issue description"
labels: [feature-request, needs-triage]
body:
- type: textarea
id: description
attributes:
label: Description
description: Short 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?
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Please include prototype/workaround/sketch/reference implementation.
validations:
required: true

- type: textarea
id: other
attributes:
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
validations:
required: false

- type: checkboxes
id: acknowledgments
attributes:
label: Acknowledge
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
attributes:
value: |
---
This is a :rocket: Feature Request
Loading

0 comments on commit a3d6a5e

Please sign in to comment.