Skip to content

Commit d5480f1

Browse files
kellertkkellertk
authored
feat: Standardize issue templates for discussions (#301)
1 parent 8c9d623 commit d5480f1

File tree

6 files changed

+160
-177
lines changed

6 files changed

+160
-177
lines changed

‎.github/ISSUE_TEMPLATE/---feature-request.yml

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/---questions---help.yml

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/---bug-report.yml renamed to ‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 73 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,73 @@
1-
name: "\U0001F41B Bug Report"
2-
description: File a bug report
3-
title: "(short issue description)"
4-
labels: [bug, needs-triage]
5-
body:
6-
- type: textarea
7-
id: description
8-
attributes:
9-
label: Describe the bug
10-
description: A clear and concise description of what the bug is.
11-
validations:
12-
required: true
13-
14-
- type: textarea
15-
id: expected
16-
attributes:
17-
label: Expected behavior
18-
description: |
19-
Tell us what should happen.
20-
validations:
21-
required: true
22-
23-
- type: textarea
24-
id: current
25-
attributes:
26-
label: Current behavior
27-
description: |
28-
Tell us what happens instead of the expected behavior.
29-
Include full errors, uncaught exceptions, stack traces, and relevant logs.
30-
validations:
31-
required: true
32-
33-
- type: textarea
34-
id: reproduction
35-
attributes:
36-
label: Steps to Reproduce
37-
description: |
38-
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
39-
For more complex issues provide a repo with the smallest sample that reproduces the bug.
40-
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
41-
validations:
42-
required: true
43-
44-
- type: textarea
45-
id: solution
46-
attributes:
47-
label: Possible Solution
48-
description: |
49-
Suggest a fix/reason for the bug
50-
validations:
51-
required: false
52-
53-
- type: input
54-
id: aws-iot-device-sdk-python-v2
55-
attributes:
56-
label: aws-iot-device-sdk-python-v2 version used
57-
validations:
58-
required: true
59-
60-
- type: input
61-
id: python-version
62-
attributes:
63-
label: Python Version used
64-
description: output of `python3 --version`
65-
validations:
66-
required: true
67-
68-
- type: input
69-
id: operating-system
70-
attributes:
71-
label: Operating System and version
72-
validations:
73-
required: true
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(short issue description)"
5+
labels: [bug, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service responses are relevant, please include wire logs.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
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.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
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.
60+
validations:
61+
required: false
62+
- type: input
63+
id: sdk-version
64+
attributes:
65+
label: SDK version used
66+
validations:
67+
required: true
68+
- type: input
69+
id: environment
70+
attributes:
71+
label: Environment details (OS name and version, etc.)
72+
validations:
73+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1+
---
12
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 General Question
5+
url: https://github.com/aws/aws-iot-device-sdk-python-v2/discussions/categories/q-a
6+
about: Please ask and answer questions as a discussion thread

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the API Reference documentation or Developer Guide
4+
title: "(short issue description)"
5+
labels: [documentation, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the issue
12+
description: A clear and concise description of the issue.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: links
18+
attributes:
19+
label: Links
20+
description: |
21+
Include links to affected documentation page(s).
22+
validations:
23+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(short issue description)"
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: other
33+
attributes:
34+
label: Other Information
35+
description: |
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false
48+
- type: input
49+
id: sdk-version
50+
attributes:
51+
label: SDK version used
52+
validations:
53+
required: true
54+
- type: input
55+
id: environment
56+
attributes:
57+
label: Environment details (OS name and version, etc.)
58+
validations:
59+
required: true

0 commit comments

Comments
 (0)