Skip to content

Commit

Permalink
chore: add GitHub issue templates (#551)
Browse files Browse the repository at this point in the history
Signed-off-by: Joel Wong <[email protected]>
  • Loading branch information
joel-wong-aws authored Feb 20, 2025
1 parent 4e7603c commit febd738
Show file tree
Hide file tree
Showing 5 changed files with 129 additions and 0 deletions.
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: "\U0001F41B Bug Report"
description: Report a bug
title: "Bug: (short bug description)"
labels: ["bug", "needs triage"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
⚠️ If the bug that you are reporting is a security-related issue or security vulnerability,
then please do not create a report via this template. Instead please
notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/)
or directly via email to [AWS Security]([email protected]).
- 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_behaviour
attributes:
label: Expected Behaviour
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: current_behaviour
attributes:
label: Current Behaviour
description: What actually happened? Please include as much detail as you can.
validations:
required: true

- type: textarea
id: reproduction_steps
attributes:
label: Reproduction Steps
description: |
Please provide as much detail as you can to help us understand how we can reproduce the bug.
Step by step instructions and self-contained code snippets are ideal.
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Please provide information on the environment and software versions that you are using to reproduce the bug.
value: |
At minimum:
1. Operating system (e.g. Windows Server 2022; Amazon Linux 2023; etc.)
2. Version of this package
Please share other details about your environment that you think might be relevant to reproducing the bug.
validations:
required: true
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
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: "📕 Documentation Issue"
description: Issue in the documentation
title: "Docs: (short description of the issue)"
labels: ["documentation", "needs triage"]
body:
- type: textarea
id: documentation_issue
attributes:
label: Documentation Issue
description: Describe the issue
validations:
required: true
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "\U0001F680 Feature Request"
description: Request a new feature
title: "Feature request: (short description of the feature)"
labels: ["enhancement", "needs triage"]
body:
- type: textarea
id: problem
attributes:
label: Describe the problem
description: |
Help us understand the problem that you are trying to solve, and why it is important to you.
Provide as much detail as you are able.
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed Solution
description: |
Describe your proposed feature that you see solving this problem for you. If you have a
full or partial prototype implementation then please open a draft pull request and link to
it here as well.
validations:
required: true

- type: textarea
id: use_case
attributes:
label: Example Use Cases
description: |
Provide some sample code snippets or shell scripts that show how **you** would use this feature as
you have proposed it.
validations:
required: true
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: "🛠️ Maintenance"
description: Some type of improvement
title: "Maintenance: (short description of the issue)"
labels: ["maintenance", "needs triage"]
body:
- type: textarea
id: description
attributes:
label: Description
description: Describe the improvement and why it is important to do.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution
description: Provide any ideas you have for how the suggestion can be implemented.
validations:
required: true

0 comments on commit febd738

Please sign in to comment.