Skip to content

Commit 26cea52

Browse files
authoredSep 12, 2022
chore: Improve Issue Templates (#2493)
1 parent eb6b5ed commit 26cea52

File tree

6 files changed

+149
-86
lines changed

6 files changed

+149
-86
lines changed
 

‎.github/ISSUE_TEMPLATE/bug.md

-26
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug.yaml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug Report
2+
description: Report a bug in Karpenter
3+
labels: bug
4+
body:
5+
- type: input
6+
id: version
7+
attributes:
8+
label: Version
9+
description: |
10+
https://github.com/aws/karpenter/releases
11+
placeholder: ex. kubectl version | grep Server
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
Briefly describe what you expected to happen
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: actual
26+
attributes:
27+
label: Actual Behavior
28+
description: |
29+
Briefly describe what is actually happening
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: steps
35+
attributes:
36+
label: Steps to Reproduce the Problem
37+
description: |
38+
How can a maintainer reproduce this issue (be detailed)?
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: specs-logs
44+
attributes:
45+
label: Resource Specs and Logs
46+
description: |
47+
Include Provisioner spec(s), pod spec(s), and Karpenter controller logs when you experienced the bug
48+
49+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
50+
validations:
51+
required: true
52+
53+
- type: markdown
54+
id: community-note
55+
attributes:
56+
value: |
57+
### Community Note
58+
59+
* 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
60+
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
61+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment

‎.github/ISSUE_TEMPLATE/docs-request.md

-27
This file was deleted.
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Docs Request/Question
2+
description: All things related to docs! Bugs, requests, suggestions, etc.
3+
labels: Documentation
4+
body:
5+
- type: input
6+
id: existing-page
7+
attributes:
8+
label: Is an existing page relevant?
9+
placeholder: ex. https://karpenter.sh/v0.16.1/upgrade-guide/
10+
11+
- type: textarea
12+
id: relevant-features
13+
attributes:
14+
label: What karpenter features are relevant?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: docs-improvement
20+
attributes:
21+
label: How should the docs be improved?
22+
validations:
23+
required: true
24+
25+
- type: markdown
26+
id: community-note
27+
attributes:
28+
value: |
29+
### Community Note
30+
31+
* 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
32+
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
33+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment

‎.github/ISSUE_TEMPLATE/request.md

-33
This file was deleted.

‎.github/ISSUE_TEMPLATE/request.yaml

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Request
2+
description: Suggest an idea for the roadmap!
3+
labels: feature
4+
body:
5+
- type: textarea
6+
id: feature
7+
attributes:
8+
label: Tell us about your request
9+
description: |
10+
What do you want us to build?
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: rationale
16+
attributes:
17+
label: Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard?
18+
description: |
19+
What outcome are you trying to achieve, ultimately, and why is it hard/impossible to do right now? What is the impact of not having this problem solved? The more details you can provide, the better we'll be able to understand and solve the problem.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: workaround
25+
attributes:
26+
label: Are you currently working around this issue?
27+
description: |
28+
How are you currently solving this problem?
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: additional
34+
attributes:
35+
label: Additional Context
36+
description: |
37+
Anything else we should know?
38+
39+
- type: textarea
40+
id: attachments
41+
attributes:
42+
label: Attachments
43+
description: |
44+
If you think you might have additional information that you'd like to include via an attachment, please do - we'll take a look. (Remember to remove any personally-identifiable information.)
45+
46+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
47+
- type: markdown
48+
id: community-note
49+
attributes:
50+
value: |
51+
### Community Note
52+
53+
* 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
54+
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
55+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment

0 commit comments

Comments
 (0)
Please sign in to comment.