Skip to content

Refactor issue templates #1770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "needs-triage"]
assignees: []
body:
- type: checkboxes
attributes:
label: Please confirm you have already done the following
options:
- label: I have searched the repository for related/existing bug reports
- label: I have all the details the issue requires
validations:
required: true
- 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
attributes:
label: Expected Behavior
description: |
What is the expected behavior?
validations:
required: true
- type: textarea
id: current
attributes:
label: Current Behavior
description: |
What actually happened?

Please include full errors, uncaught exceptions, stack traces, and relevant VERBOSE logs.
To get relevant VERBOSE logs from the SDK, you can retrieve by running `export AWS_KVS_LOG_LEVEL=1`
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction Steps
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: input
id: sdk-version
attributes:
label: WebRTC C SDK version being used
validations:
required: true
- type: input
id: compiler-version
attributes:
label: Compiler and Version used
description: gcc --version / Visual Studio / clang --version
validations:
required: true
- type: input
id: operating-system
attributes:
label: Operating System and version
validations:
required: true
- type: input
id: platform
attributes:
label: Platform being used
validations:
required: true
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
blank_issues_enabled: false
contact_links:
- name: General Question
url: https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-c/discussions
about: Please ask and answer questions as a discussion thread
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/contribution.md

This file was deleted.

31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: "Documentation Issue"
description: Report an issue in the github Readme. For issues in AWS documentation pages, submit feedback on the concerned AWS page
title: "[Documentation]: "
labels: ["documentation", "needs-triage"]
assignees: []
body:
- type: checkboxes
attributes:
label: Please confirm you have already done the following
options:
- label: I have searched the repository for related/existing documentation issue reports
- label: I have all the details the issue requires
validations:
required: true
- type: textarea
id: description
attributes:
label: Describe the issue
description: A clear and concise description of the issue.
validations:
required: true

- type: textarea
id: links
attributes:
label: Links
description: |
Include links to affected documentation page(s).
validations:
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Feature Request
description: Suggest an idea for this project
title: "[Feature request]: "
labels: [feature-request, needs-triage]
assignees: []
body:
- type: checkboxes
attributes:
label: Please confirm you have already done the following
options:
- label: I have searched the repository for related/existing feature requests
- label: I have all the details the issue requires
validations:
required: true
- 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: use-case
attributes:
label: Use Case
description: |
Why do you need this feature?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
validations:
required: false
- type: textarea
id: other
attributes:
label: Other Information
description: |
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
validations:
required: false
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/questions-help.md

This file was deleted.