Skip to content

Commit 087c850

Browse files
authored
Merge pull request #112 from awslabs/templates
github: add issue templates for bug, feature, and docs
2 parents 403a9e7 + 35bf292 commit 087c850

File tree

4 files changed

+95
-0
lines changed

4 files changed

+95
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Bug
2+
description: Report a bug
3+
labels:
4+
- kind/bug
5+
- needs-triage
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Description
10+
value: |
11+
<!-- Please craft a detailed description of the documentation issue or suggestion -->
12+
<!-- Below are some suggestions but feel free to modify or remove them -->
13+
14+
**Observed Behavior**:
15+
16+
**Expected Behavior**:
17+
18+
**Reproduction Steps** (Please include `ResourceGroup` and `Instances` files):
19+
20+
**Versions**:
21+
- KRO Version:
22+
- Kubernetes Version (`kubectl version`):
23+
24+
**Involved Controllers**:
25+
- Controller URLs and Versions (if applicable):
26+
27+
**Error Logs** (if applicable)**:
28+
```
29+
Paste any relevant logs here
30+
```
31+
32+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
33+
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
34+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
35+
- type: dropdown
36+
id: issue_type
37+
attributes:
38+
label: Which option describes the most your issue?
39+
multiple: true
40+
options:
41+
- ResourceGroup (Create, Update, Deletion)
42+
- Instance (Create, Update, Deletion)
43+
- Directed Acyclic Graph inference
44+
- Common Expression Language (CEL)
45+
- Schema Validation
46+
- Others (please specify)

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Documentation
2+
description: Report documentation issues or suggest improvements
3+
labels:
4+
- kind/documentation
5+
- needs-triage
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Documentation Issue
10+
value: |
11+
<!-- Please craft a detailed description of the documentation issue or suggestion -->
12+
<!-- Below are some suggestions but feel free to modify or remove them -->
13+
14+
**Location**:
15+
<!-- Specify where the documentation issue is (URL, file path, etc.) -->
16+
17+
**Current State**:
18+
<!-- What does the current documentation say? -->
19+
20+
**Suggested Changes**:
21+
<!-- How should it be improved? -->
22+
23+
**Additional Context**:
24+
<!-- Any additional information that might be helpful -->
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
labels:
4+
- kind/feature
5+
- needs-triage
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Feature Description
10+
value: |
11+
**Problem Statement**:
12+
<!-- What problem are you trying to solve? -->
13+
14+
**Proposed Solution**:
15+
<!-- Describe your proposed solution -->
16+
17+
**Alternatives Considered**:
18+
<!-- What alternatives have you considered? -->
19+
20+
**Additional Context**:
21+
<!-- Add any other context about the feature request here -->
22+
23+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue
24+
* If you are interested in working on this feature, please leave a comment

0 commit comments

Comments
 (0)