Skip to content

Commit

Permalink
Issue templates (#243)
Browse files Browse the repository at this point in the history
* added issue templates
  • Loading branch information
jmklix authored Mar 30, 2022
1 parent d9c8d0d commit 75dcec6
Show file tree
Hide file tree
Showing 7 changed files with 178 additions and 82 deletions.
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/---bug-report.md

This file was deleted.

73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/---bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: "\U0001F41B Bug Report"
description: File a bug report
title: "(short issue description)"
labels: [bug, needs-triage]
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: |
Tell us what should happen.
validations:
required: true

- type: textarea
id: current
attributes:
label: Current behavior
description: |
Tell us what happens instead of the expected behavior.
Include full errors, uncaught exceptions, stack traces, and relevant logs.
validations:
required: true

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

- type: textarea
id: solution
attributes:
label: Possible Solution
description: |
Suggest a fix/reason for the bug
validations:
required: false

- type: input
id: aws-iot-device-sdk-java-v2
attributes:
label: aws-iot-device-sdk-java-v2 version used
validations:
required: true

- type: input
id: compiler-version
attributes:
label: JDK Version used
description: Output of `java -version`
validations:
required: true

- type: input
id: operating-system
attributes:
label: Operating System and version
validations:
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/---feature-request.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/---feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "\U0001F680 Feature Request"
description: Suggest an idea for this project
title: "(short issue description)"
labels: [feature-request, needs-triage]
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: problem
attributes:
label: Is your Feature Request related to a problem?
description: |
A description of the issue, e.g. "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.
validations:
required: false

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: |
Any alternative solutions or features you've considered.
validations:
required: false

- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledge
options:
- label: I may be able to implement this feature request
required: false
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/---questions---help.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/---questions---help.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: "\U0001F4AC General Issue"
description: Create a new issue. If you don't know which type to choose, choose this one.
title: "(short issue description)"
labels: [guidance, needs-triage]
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: reproduction
attributes:
label: Steps to Reproduce
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 reproducible example.
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
validations:
required: false

- type: textarea
id: current
attributes:
label: Current behavior
description: |
Tell us what happens instead of the expected behavior.
Include full errors, uncaught exceptions, stack traces, and relevant logs.
validations:
required: false

- type: input
id: aws-iot-device-sdk-java-v2
attributes:
label: aws-iot-device-sdk-java-v2 version used
validations:
required: true

- type: input
id: compiler-version
attributes:
label: JDK version used
description: Output of `java -version`
validations:
required: true

- type: input
id: operating-system
attributes:
label: Operating System and version
validations:
required: true
2 changes: 1 addition & 1 deletion .github/workflows/stale_issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

# These labels are required
stale-issue-label: closing-soon
exempt-issue-label: investigating
exempt-issue-label: investigating, automation-exempt
stale-pr-label: closing-soon
exempt-pr-label: pr/needs-review
response-requested-label: response-requested
Expand Down

0 comments on commit 75dcec6

Please sign in to comment.