Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Upgrade to GitHub Issues v2 #216

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
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: |
1. Example rules and template that results in the error
1. The commands you used to invoke the tool
1. The output of a `-v` log level if it's not related to cfn-guard-lambda, or the relevant CloudWatch log messages if it is related to the cfn-guard-lambda
validations:
required: true

- type: markdown
attributes:
value: |
**NOTE: Please be sure that the templates, rules and logs you provide as part of your bug report do not contain any sensitive information.**

- 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: guard-version
attributes:
label: CloudFormation Guard Version
description: Output of `cfn-guard -V`
validations:
required: true

- type: input
id: operating-system
attributes:
label: OS
description: E.g. MacOS | Windows | Ubuntu
validations:
required: true

- type: input
id: os-version
attributes:
label: OS Version
description: E.g. Catalina | 10 | 18.04
validations:
required: false

- type: textarea
id: other
attributes:
label: Other information
description: |
e.g. detailed explanation, scrennshots, 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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
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: 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
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/example_rules.md

This file was deleted.

24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
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, screenshots, 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: |
### Community Note
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request

- type: markdown
attributes:
value: |
---
This is a :rocket: Feature Request
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/general_issue.md

This file was deleted.

63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/general_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: General Issue
description: Create a new issue
title: "(module name): short issue description"
labels: [needs-triage, guidance]
body:
- type: markdown
attributes:
value: |
If your issue does not fall in any of the other categories create an issue with this template.

- type: input
id: issue
attributes:
label: General Issue
description: |
Important Information - Please look at the following sections before creating an issue to see if your question was already answered:
* [Open issues](https://github.com/aws-cloudformation/cloudformation-guard/issues)
* All our [PRs](https://github.com/aws-cloudformation/cloudformation-guard/pulls?q=is%3Apr), both open and close
* Our [documentation](https://github.com/aws-cloudformation/cloudformation-guard#aws-cloudformation-guard)
validations:
required: true

- type: textarea
id: question
attributes:
label: The Question
description: |
Ask your question here. Include any details relevant.
validations:
required: true

- type: input
id: guard-version
attributes:
label: CloudFormation Guard Version
description: Output of `cfn-guard -V`
validations:
required: true

- type: input
id: operating-system
attributes:
label: OS
description: E.g. MacOS | Windows | Ubuntu
validations:
required: true

- type: input
id: os-version
attributes:
label: OS Version
description: E.g. Catalina | 10 | 18.04
validations:
required: false

- type: textarea
id: other
attributes:
label: Other information
description: |
e.g. detailed explanation, scrennshots, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
validations:
required: false
Loading