Skip to content

Commit f11e365

Browse files
jmklixjmklix
authored
Issue templates (#67)
* add github templates and bots * Update bug-report.yml * Update config.yml * Update stale_issue.yml * Update stale_issue.yml * Update stale_issue.yml
1 parent ac37a05 commit f11e365

File tree

6 files changed

+220
-0
lines changed

6 files changed

+220
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(short issue description)"
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 did you expect to happen?
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 logs.
31+
If service responses are relevant, please include wire logs.
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+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
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.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
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.
60+
validations:
61+
required: false
62+
63+
- type: input
64+
id: aws-crt-kotlin-version
65+
attributes:
66+
label: aws-crt-kotlin version used
67+
validations:
68+
required: true
69+
70+
- type: input
71+
id: compiler-version
72+
attributes:
73+
label: Kotlin version used
74+
validations:
75+
required: true
76+
77+
- type: input
78+
id: operating-system
79+
attributes:
80+
label: Operating System and version
81+
validations:
82+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 General Question
4+
url: https://github.com/awslabs/aws-crt-kotlin/discussions/categories/q-a
5+
about: Please ask and answer questions as a discussion thread

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 23 additions & 0 deletions
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: "(short issue description)"
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.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(short issue description)"
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? For example: "I'm always frustrated when..."
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
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false

‎.github/workflows/closed-issue-message.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Closed Issue Message
2+
on:
3+
issues:
4+
types: [closed]
5+
jobs:
6+
auto_comment:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: aws-actions/closed-issue-message@v1
10+
with:
11+
# These inputs are both required
12+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
13+
message: |
14+
### ⚠️COMMENT VISIBILITY WARNING⚠️
15+
Comments on closed issues are hard for our team to see.
16+
If you need more assistance, please either tag a team member or open a new issue that references this one.
17+
If you wish to keep having a conversation with other community members under this issue feel free to do so.

‎.github/workflows/stale_issue.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "Close stale issues"
2+
3+
# Controls when the action will run.
4+
on:
5+
schedule:
6+
- cron: "*/60 * * * *"
7+
8+
jobs:
9+
cleanup:
10+
runs-on: ubuntu-latest
11+
name: Stale issue job
12+
steps:
13+
- uses: aws-actions/stale-issue-cleanup@v3
14+
with:
15+
# Setting messages to an empty string will cause the automation to skip
16+
# that category
17+
ancient-issue-message: Greetings! Sorry to say but this is a very old issue that is probably not getting as much attention as it deserves. 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.
18+
stale-issue-message: Greetings! It looks like this issue hasn’t been active in a few days. We encourage you to check if this is still an issue in the latest release. Because it has been a few days 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.
19+
stale-pr-message: Greetings! It looks like this PR hasn’t been active in a few days, 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.
20+
21+
# These labels are required
22+
stale-issue-label: closing-soon
23+
exempt-issue-label: automation-exempt
24+
stale-pr-label: closing-soon
25+
exempt-pr-label: pr/needs-review
26+
response-requested-label: response-requested
27+
28+
# Don't set closed-for-staleness label to skip closing very old issues
29+
# regardless of label
30+
closed-for-staleness-label: closed-for-staleness
31+
32+
# Issue timing
33+
days-before-stale: 2
34+
days-before-close: 5
35+
days-before-ancient: 36500
36+
37+
# If you don't want to mark a issue as being ancient based on a
38+
# threshold of "upvotes", you can set this here. An "upvote" is
39+
# the total number of +1, heart, hooray, and rocket reactions
40+
# on an issue.
41+
minimum-upvotes-to-exempt: 1
42+
43+
repo-token: ${{ secrets.GITHUB_TOKEN }}
44+
loglevel: DEBUG
45+
# Set dry-run to true to not perform label or close actions.
46+
dry-run: false

0 commit comments

Comments
 (0)