Skip to content

Commit 9759590

Browse files
committed
Modify issue templates
1 parent b820e2e commit 9759590

8 files changed

+135
-108
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-48
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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: 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 is the expected behavior?
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 VERBOSE logs.
31+
To get relevant VERBOSE logs from the SDK, you can retrieve by running `export AWS_KVS_LOG_LEVEL = 1`
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+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
42+
validations:
43+
required: true
44+
- type: input
45+
id: sdk-version
46+
attributes:
47+
label: WebRTC C SDK version being used
48+
validations:
49+
required: true
50+
- type: input
51+
id: compiler-version
52+
attributes:
53+
label: Compiler and Version used
54+
description: gcc --version / Visual Studio / clang --version
55+
validations:
56+
required: true
57+
- type: input
58+
id: operating-system
59+
attributes:
60+
label: Operating System and version
61+
validations:
62+
required: true
63+
- type: input
64+
id: platform
65+
attributes:
66+
label: Platform being used
67+
validations:
68+
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.
+23
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: "[Documentation]: "
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.md

-20
This file was deleted.
+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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: 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?
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

.github/ISSUE_TEMPLATE/questions-help.md

-18
This file was deleted.

0 commit comments

Comments
 (0)