-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add github issue and PR templates (#30)
- Loading branch information
1 parent
5b93c0a
commit 8023eb6
Showing
7 changed files
with
243 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
name: Bug Report Form | ||
description: Report unexpected behavior during a meeting session here | ||
body: | ||
- type: input | ||
id: subproject | ||
attributes: | ||
label: Is this an issue with the Amazon Chime SDK for C++ or with the Amazon Chime SDK for C++ Signaling Client? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened and what did you expect to happen? | ||
description: | | ||
Observed problem and expected result. | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: existing-resources-check | ||
attributes: | ||
label: Have you reviewed our existing documentation? | ||
description: Please check all resources as your issue may have been addressed before. | ||
options: | ||
- label: GitHub [issues](https://github.com/aws/amazon-chime-sdk-cpp/issues) | ||
required: true | ||
- type: textarea | ||
id: reproduction-steps | ||
attributes: | ||
label: Reproduction steps | ||
description: Steps to reproduce this issue. | ||
validations: | ||
required: true | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Library version | ||
description: What version of the Amazon Chime SDK for C++ or Amazon Chime SDK for C++ Signaling Client are you running? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: meeting-attendee-ids | ||
attributes: | ||
label: Meeting and Attendee ID Information. | ||
description: Provide specific meeting and attendee ID if you have. | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Client logs | ||
description: | | ||
Please attach logs with timestamps to the report from *before* the session started up until the point at which the unexpected behavior occurred. | ||
For multi-participant calls, attach a log file for each participant if possible. | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Community Request Template | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: feature-request | ||
assignees: '' | ||
|
||
--- | ||
|
||
# Community Note | ||
* Please vote for this issue by adding a 👍 reaction to the issue. This will help the community and maintainers from the Amazon Chime SDK team to prioritize this request. | ||
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request. | ||
* Please go through the existing [issues](https://github.com/aws/amazon-chime-sdk-cpp/issues) to see if your request has already been recommended. | ||
* Please do not use this template for bugs or support. | ||
* If you are interested in working on this issue or have submitted a pull request, please leave a comment. | ||
|
||
# Tell us about your request | ||
## Is this a request for the Amazon Chime SDK for C++, or with the Amazon Chime SDK for C++ Signaling Client? | ||
|
||
## What do you want us to build? | ||
|
||
## Tell us about the problem you are trying to solve and why is it hard? | ||
The more details you provide us, the better we will be able to help you. | ||
|
||
## How are you currently solving a problem? | ||
Are there any workarounds or mitigations you have used? Why is it not working for you? | ||
|
||
## Additional context | ||
Anything else we should know? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: Build Failure Report | ||
description: Report unexpected build failures with the project | ||
body: | ||
- type: input | ||
id: subproject | ||
attributes: | ||
label: Is this an issue with the Amazon Chime SDK for C++ or with the Amazon Chime SDK for C++ Signaling Client? | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: existing-resources-check | ||
attributes: | ||
label: Have you reviewed our existing documentation? | ||
description: Please check all resources as your issue may have been addressed before. | ||
options: | ||
- label: GitHub [issues](https://github.com/aws/amazon-chime-sdk-cpp/issues) | ||
required: true | ||
- type: input | ||
id: platforms | ||
attributes: | ||
label: What Windows version are you seeing the problem on? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: build-command | ||
attributes: | ||
label: Build setup | ||
description: How are you currently linking the Windows binary? | ||
validations: | ||
required: true | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Amazon Chime SDK for C++ Windows Binary version | ||
description: What version of our Amazon Chime SDK for C++ Windows Binary are you trying to build? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: error | ||
attributes: | ||
label: Error Log | ||
description: Please provide the error. If possible, attach the entire build log to the issue after posting. | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Documentation request | ||
about: Need help using the SDK? Spot an error? Let us know how our documentation can be improved. | ||
title: '' | ||
labels: 'documentation' | ||
assignees: '' | ||
|
||
--- | ||
|
||
### What are you trying to do? | ||
|
||
*For example: I'm trying to start a meeting session with audio.* | ||
|
||
### How can the documentation be improved to help your use case? | ||
|
||
*For example: Include a section on how to configure the meeting session.* | ||
|
||
### What documentation have you looked at so far? | ||
|
||
*For example: README.md, Amazon Chime SDK Developer Guide, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
name: Build Failure Report | ||
description: Report unexpected build failures with the project | ||
body: | ||
- type: input | ||
id: subproject | ||
attributes: | ||
label: Is this an issue with the Amazon Chime SDK for C++ or with the Amazon Chime SDK for C++ Signaling Client? | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: existing-resources-check | ||
attributes: | ||
label: Have you reviewed our existing documentation? | ||
description: Please check all resources as your issue may have been addressed before. | ||
options: | ||
- label: GitHub [issues](https://github.com/aws/amazon-chime-sdk-cpp/issues) | ||
required: true | ||
- label: README [page](https://github.com/aws/amazon-chime-sdk-cpp/tree/main/chime-sdk-signaling-cpp) | ||
required: true | ||
- type: input | ||
id: platforms | ||
attributes: | ||
label: What platforms are you seeing the problem on? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: build-command | ||
attributes: | ||
label: Build command. | ||
description: What `cmake` command was used to build the project? If this issue is downstream of the build, please explain your setup. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: dependencies-webrtc | ||
attributes: | ||
label: WebRTC Dependency | ||
description: What WebRTC implementation is being used, and which version? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: dependencies-ssl | ||
attributes: | ||
label: SSL Dependency | ||
description: What SSL libary is being used, and which version? Was it installed using a package manager, or built from source? | ||
validations: | ||
required: true | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Amazon Chime SDK for C++ Signaling Client version | ||
description: What commit/tag of our Amazon Chime SDK for C++ Signaling Client are you trying to build? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: error | ||
attributes: | ||
label: Error Log | ||
description: Please provide the error. If possible, attach the entire build log to the issue after posting. | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
**Issue #:** | ||
|
||
**Description of changes:** | ||
|
||
**Testing:** | ||
*Can these tested using the demo CLI? Please provide reproducible step-by-step instructions.* | ||
|
||
**Checklist:** | ||
|
||
1. What platforms has this change been built on? What `cmake` commands were used to generate the build files? | ||
|
||
2. Does this change risk impacting platforms other then the one tested? | ||
|
||
3. Do you add, modify, or delete public API definitions? If yes, has that been reviewed and approved? | ||
|
||
4. Do you change the wire protocol, e.g. the request method? If yes, has that been reviewed and approved? | ||
|
||
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"files.associations": { | ||
"*.Makefile": "makefile", | ||
"algorithm": "cpp", | ||
"optional": "cpp" | ||
} | ||
} |