-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add github templates and bots * Update bug-report.yml * Update config.yml
- Loading branch information
Showing
6 changed files
with
220 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,82 @@ | ||
--- | ||
name: "🐛 Bug Report" | ||
description: Report a bug | ||
title: "(short issue description)" | ||
labels: [bug, needs-triage] | ||
assignees: [] | ||
body: | ||
- 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 did you expect to happen? | ||
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 logs. | ||
If service responses are relevant, please include wire logs. | ||
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. | ||
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. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Possible Solution | ||
description: | | ||
Suggest a fix/reason for the bug | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional Information/Context | ||
description: | | ||
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. | ||
validations: | ||
required: false | ||
|
||
- type: input | ||
id: aws-crt-python-version | ||
attributes: | ||
label: aws-crt-python version used | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: compiler-version | ||
attributes: | ||
label: Python version used | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: operating-system | ||
attributes: | ||
label: Operating System and version | ||
validations: | ||
required: true |
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,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: 💬 General Question | ||
url: https://github.com/awslabs/aws-crt-python/discussions/categories/q-a | ||
about: Please ask and answer questions as a discussion thread |
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,23 @@ | ||
--- | ||
name: "📕 Documentation Issue" | ||
description: Report an issue in the API Reference documentation or Developer Guide | ||
title: "(short issue description)" | ||
labels: [documentation, needs-triage] | ||
assignees: [] | ||
body: | ||
- 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 |
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,47 @@ | ||
--- | ||
name: 🚀 Feature Request | ||
description: Suggest an idea for this project | ||
title: "(short issue description)" | ||
labels: [feature-request, needs-triage] | ||
assignees: [] | ||
body: | ||
- 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? For example: "I'm always frustrated when..." | ||
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 | ||
- type: checkboxes | ||
id: ack | ||
attributes: | ||
label: Acknowledgements | ||
options: | ||
- label: I may be able to implement this feature request | ||
required: false | ||
- label: This feature might incur a breaking change | ||
required: false |
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,17 @@ | ||
name: Closed Issue Message | ||
on: | ||
issues: | ||
types: [closed] | ||
jobs: | ||
auto_comment: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: aws-actions/closed-issue-message@v1 | ||
with: | ||
# These inputs are both required | ||
repo-token: "${{ secrets.GITHUB_TOKEN }}" | ||
message: | | ||
### ⚠️COMMENT VISIBILITY WARNING⚠️ | ||
Comments on closed issues are hard for our team to see. | ||
If you need more assistance, please either tag a team member or open a new issue that references this one. | ||
If you wish to keep having a conversation with other community members under this issue feel free to do so. |
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,46 @@ | ||
name: "Close stale issues" | ||
|
||
# Controls when the action will run. | ||
on: | ||
schedule: | ||
- cron: "*/60 * * * *" | ||
|
||
jobs: | ||
cleanup: | ||
runs-on: ubuntu-latest | ||
name: Stale issue job | ||
steps: | ||
- uses: aws-actions/stale-issue-cleanup@v3 | ||
with: | ||
# Setting messages to an empty string will cause the automation to skip | ||
# that category | ||
ancient-issue-message: Greetings! Sorry to say but this is a very old issue that is probably not getting as much attention as it deservers. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to open a new one. | ||
stale-issue-message: Greetings! It looks like this issue hasn’t been active in longer than a week. We encourage you to check if this is still an issue in the latest release. Because it has been longer than a week since the last update on this, and in the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please feel free to provide a comment or add an upvote to prevent automatic closure, or if the issue is already closed, please feel free to open a new one. | ||
stale-pr-message: Greetings! It looks like this PR hasn’t been active in longer than a week, add a comment or an upvote to prevent automatic closure, or if the issue is already closed, please feel free to open a new one. | ||
|
||
# These labels are required | ||
stale-issue-label: closing-soon | ||
exempt-issue-label: automation-exempt | ||
stale-pr-label: closing-soon | ||
exempt-pr-label: pr/needs-review | ||
response-requested-label: response-requested | ||
|
||
# Don't set closed-for-staleness label to skip closing very old issues | ||
# regardless of label | ||
closed-for-staleness-label: closed-for-staleness | ||
|
||
# Issue timing | ||
days-before-stale: 2 | ||
days-before-close: 5 | ||
days-before-ancient: 365 | ||
|
||
# If you don't want to mark a issue as being ancient based on a | ||
# threshold of "upvotes", you can set this here. An "upvote" is | ||
# the total number of +1, heart, hooray, and rocket reactions | ||
# on an issue. | ||
minimum-upvotes-to-exempt: 1 | ||
|
||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
loglevel: DEBUG | ||
# Set dry-run to true to not perform label or close actions. | ||
dry-run: false |