Skip to content

Commit

Permalink
chore: add issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rexagod committed Jul 17, 2024
1 parent de834e9 commit 7490c46
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bugs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bug Report
description: Report a bug in the existing codebase.
title: '[Bug]: '
labels: ['kind/bug', 'pending-triage']
body:
- type: markdown
attributes:
value: |
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).
- type: textarea
id: cause
attributes:
label: What happened?
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.
placeholder: Describe the bug you encountered. Please do not paste any snippets here, use the next field instead.
validations:
required: true
- type: textarea
id: snippet
attributes:
label: Please provide any helpful snippets.
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.
render: jsonnet
- type: dropdown
id: contamination
attributes:
label: What parts of the codebase are affected?
description: Select all that apply.
multiple: true
options:
- Alerts
- Dashboards
- Rules
- Other
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: "I agree to the following terms:"
options:
- label: I agree to follow this project's [Code of Conduct](../../CODE_OF_CONDUCT.md).
required: true
- label: I have filled out all the required information above to the best of my ability.
required: true
- label: I have searched the issues of this repository and believe that this is not a duplicate.
required: true
- label: I have confirmed this bug exists in the default branch of the repository, as of the latest commit at the time of submission.
required: true
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancements.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Enhancement Proposal
description: Propose an enhancement for the existing codebase.
title: '[Enhancement]: '
labels: ['kind/enhancement', 'pending-triage']
body:
- type: markdown
attributes:
value: |
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.
- type: textarea
id: idea
attributes:
label: What's the general idea for the enhancement?
description: A clear and concise description of what the enhancement targets. Screenshots and screencasts are highly encouraged and helpful during triage, so please provide them if you can.
placeholder: Describe the need for this enhancement. Please do not paste any snippets here, use the next field instead.
validations:
required: true
- type: textarea
id: snippet
attributes:
label: Please provide any helpful snippets.
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.
render: jsonnet
- type: dropdown
id: contamination
attributes:
label: What parts of the codebase does the enhancement target?
description: Select all that apply.
multiple: true
options:
- Alerts
- Dashboards
- Rules
- Other
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: "I agree to the following terms:"
options:
- label: I agree to follow this project's [Code of Conduct](../../CODE_OF_CONDUCT.md).
required: true
- label: I have filled out all the required information above to the best of my ability.
required: true
- label: I have searched the issues of this repository and believe that this is not a duplicate.
required: true
- label: I have confirmed this proposal applies to the default branch of the repository, as of the latest commit at the time of submission.
required: true
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/prs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Thank you for sending a pull request! We highly appreciate contributions. Here are some tips for you:
1. If this is your first time, read our contributor guidelines: https://github.com/kubernetes-monitoring/kubernetes-mixin/blob/master/CONTRIBUTING.md
2. If you want *faster* PR reviews, read how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
3. If the PR is unfinished, please mark it as a draft, to prevent false pings and noisy review cycles.
-->

**What does this PR fix? Please be as descriptive as possible.**:

**Code snippets or visual aids (screenshots and/or screencasts) before and after this patch (if applicable)**:
<details>
<summary>Details</summary>

<!-- Please provide code snippets or visual aids to help explain the changes you're making. These are highly helpful and help accelerate reviews. -->

</details>

<!-- Please append the issue(s) this PR targets below this line -->
Fixes #

0 comments on commit 7490c46

Please sign in to comment.