Skip to content

Commit bcf8205

Browse files
rexagodrexagod
committedJul 18, 2024··
chore: add issue and pr templates
1 parent 3dfa72d commit bcf8205

File tree

3 files changed

+123
-0
lines changed

3 files changed

+123
-0
lines changed
 

‎.github/ISSUE_TEMPLATE/bugs.yaml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Bug Report
2+
description: Report a bug in the existing codebase.
3+
title: '[Bug]: '
4+
labels: ['kind/bug', 'pending-triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please use this template while reporting a bug and provide as much information as possible. If the matter is security related, please disclose it privately, see the project [security policy](https://github.com/kubernetes-monitoring/kubernetes-mixin/blob/main/SECURITY.md).
10+
- type: textarea
11+
id: cause
12+
attributes:
13+
label: What happened?
14+
description: A clear and concise description of what the bug is. Screenshots and screencasts are highly encouraged and helpful during triage, so please provide them if you can.
15+
placeholder: Describe the bug you encountered. Please do not paste any snippets here, use the next field instead.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: snippet
20+
attributes:
21+
label: Please provide any helpful snippets.
22+
description: If applicable, add code snippet(s) to help explain or reproduce the problem. This will be automatically formatted into code, so no need for backticks. Separate snippets using comments.
23+
render: jsonnet
24+
- type: dropdown
25+
id: contamination
26+
attributes:
27+
label: What parts of the codebase are affected?
28+
description: Select all that apply.
29+
multiple: true
30+
options:
31+
- Alerts
32+
- Dashboards
33+
- Rules
34+
- Other
35+
validations:
36+
required: true
37+
- type: checkboxes
38+
id: terms
39+
attributes:
40+
label: "I agree to the following terms:"
41+
options:
42+
- label: I agree to follow this project's [Code of Conduct](../../CODE_OF_CONDUCT.md).
43+
required: true
44+
- label: I have filled out all the required information above to the best of my ability.
45+
required: true
46+
- label: I have searched the issues of this repository and believe that this is not a duplicate.
47+
required: true
48+
- label: I have confirmed this bug exists in the default branch of the repository, as of the latest commit at the time of submission.
49+
required: true

‎.github/ISSUE_TEMPLATE/enhancements.yaml

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Enhancement Proposal
2+
description: Propose an enhancement for the existing codebase.
3+
title: '[Enhancement]: '
4+
labels: ['kind/enhancement', 'pending-triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please use this template while proposing an enhancement and provide as much information as possible. If this is a feature request, please ensure that [a consensus has been reached](https://github.com/kubernetes-monitoring/kubernetes-mixin/blob/master/CONTRIBUTING.md?plain=1#L24) before submitting.
10+
- type: textarea
11+
id: idea
12+
attributes:
13+
label: What's the general idea for the enhancement?
14+
description: A clear and concise description of the enhancement's targeted problem and its proposed solution. Screenshots and screencasts are highly encouraged and helpful during triage, so please provide them if you can.
15+
placeholder: Describe the need for this enhancement. Please do not paste any snippets here, use the next field instead.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: snippet
20+
attributes:
21+
label: Please provide any helpful snippets.
22+
description: If applicable, add code snippet(s) to help explain or reproduce the problem. This will be automatically formatted into code, so no need for backticks. Separate snippets using comments.
23+
render: jsonnet
24+
- type: dropdown
25+
id: contamination
26+
attributes:
27+
label: What parts of the codebase does the enhancement target?
28+
description: Select all that apply.
29+
multiple: true
30+
options:
31+
- Alerts
32+
- Dashboards
33+
- Rules
34+
- Other
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: extra
39+
attributes:
40+
label: Anything else relevant to the enhancement that would help with the triage process?
41+
description: Any additional context or information that would be helpful to the maintainers. For example, if you have considered any alternatives or workarounds, please share them here.
42+
placeholder: Add any additional information here.
43+
- type: checkboxes
44+
id: terms
45+
attributes:
46+
label: "I agree to the following terms:"
47+
options:
48+
- label: I agree to follow this project's [Code of Conduct](../../CODE_OF_CONDUCT.md).
49+
required: true
50+
- label: I have filled out all the required information above to the best of my ability.
51+
required: true
52+
- label: I have searched the issues of this repository and believe that this is not a duplicate.
53+
required: true
54+
- label: I have confirmed this proposal applies to the default branch of the repository, as of the latest commit at the time of submission.
55+
required: true

‎.github/PULL_REQUEST_TEMPLATE/prs.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Thank you for sending a pull request! We highly appreciate contributions. Here are some tips for you:
2+
1. If this is your first time, read our contributor guidelines: https://github.com/kubernetes-monitoring/kubernetes-mixin/blob/master/CONTRIBUTING.md
3+
2. If you want *faster* PR reviews, read how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
4+
3. If the PR is unfinished, please mark it as a draft, to prevent false pings and noisy review cycles.
5+
-->
6+
7+
#### What does this PR fix? Please be as descriptive as possible.**
8+
9+
#### Any helpful code snippets or visual aids (before and after this patch, if applicable)?**
10+
<details>
11+
<summary>Details</summary>
12+
13+
<!-- Please provide code snippets or (dashboard) screenshots to help explain the changes you're making. These are highly helpful and help accelerate reviews. -->
14+
15+
</details>
16+
17+
<!-- Please append the issue(s) this PR targets below this line. -->
18+
19+
Fixes #

0 commit comments

Comments
 (0)
Please sign in to comment.