Skip to content

Commit 82ae3bf

Browse files
authored
Refactor issue templates (#1770)
1 parent 4635b64 commit 82ae3bf

8 files changed

+159
-108
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-48
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Bug Report
3+
description: File a bug report
4+
title: "[Bug]: "
5+
labels: ["bug", "needs-triage"]
6+
assignees: []
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Please confirm you have already done the following
11+
options:
12+
- label: I have searched the repository for related/existing bug reports
13+
- label: I have all the details the issue requires
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Describe the bug
20+
description: What is the problem? A clear and concise description of the bug.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: expected
25+
attributes:
26+
label: Expected Behavior
27+
description: |
28+
What is the expected behavior?
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: current
33+
attributes:
34+
label: Current Behavior
35+
description: |
36+
What actually happened?
37+
38+
Please include full errors, uncaught exceptions, stack traces, and relevant VERBOSE logs.
39+
To get relevant VERBOSE logs from the SDK, you can retrieve by running `export AWS_KVS_LOG_LEVEL=1`
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: reproduction
44+
attributes:
45+
label: Reproduction Steps
46+
description: |
47+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
48+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
49+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
50+
validations:
51+
required: true
52+
- type: input
53+
id: sdk-version
54+
attributes:
55+
label: WebRTC C SDK version being used
56+
validations:
57+
required: true
58+
- type: input
59+
id: compiler-version
60+
attributes:
61+
label: Compiler and Version used
62+
description: gcc --version / Visual Studio / clang --version
63+
validations:
64+
required: true
65+
- type: input
66+
id: operating-system
67+
attributes:
68+
label: Operating System and version
69+
validations:
70+
required: true
71+
- type: input
72+
id: platform
73+
attributes:
74+
label: Platform being used
75+
validations:
76+
required: true

.github/ISSUE_TEMPLATE/config.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: General Question
5+
url: https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-c/discussions
6+
about: Please ask and answer questions as a discussion thread

.github/ISSUE_TEMPLATE/contribution.md

-22
This file was deleted.
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: "Documentation Issue"
3+
description: Report an issue in the github Readme. For issues in AWS documentation pages, submit feedback on the concerned AWS page
4+
title: "[Documentation]: "
5+
labels: ["documentation", "needs-triage"]
6+
assignees: []
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Please confirm you have already done the following
11+
options:
12+
- label: I have searched the repository for related/existing documentation issue reports
13+
- label: I have all the details the issue requires
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Describe the issue
20+
description: A clear and concise description of the issue.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: links
26+
attributes:
27+
label: Links
28+
description: |
29+
Include links to affected documentation page(s).
30+
validations:
31+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

-20
This file was deleted.
+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Feature Request
3+
description: Suggest an idea for this project
4+
title: "[Feature request]: "
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Please confirm you have already done the following
11+
options:
12+
- label: I have searched the repository for related/existing feature requests
13+
- label: I have all the details the issue requires
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Describe the feature
20+
description: A clear and concise description of the feature you are proposing.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: use-case
25+
attributes:
26+
label: Use Case
27+
description: |
28+
Why do you need this feature?
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: solution
33+
attributes:
34+
label: Proposed Solution
35+
description: |
36+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: other
41+
attributes:
42+
label: Other Information
43+
description: |
44+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
45+
validations:
46+
required: false

.github/ISSUE_TEMPLATE/questions-help.md

-18
This file was deleted.

0 commit comments

Comments
 (0)