From 7490c4669470b242368d1c1a33bc539c4f7440a6 Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Wed, 17 Jul 2024 18:47:09 +0530 Subject: [PATCH] chore: add issue and pr templates --- .github/ISSUE_TEMPLATE/bugs.yaml | 49 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancements.yaml | 49 ++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/prs.md | 18 +++++++++ 3 files changed, 116 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bugs.yaml create mode 100644 .github/ISSUE_TEMPLATE/enhancements.yaml create mode 100644 .github/PULL_REQUEST_TEMPLATE/prs.md diff --git a/.github/ISSUE_TEMPLATE/bugs.yaml b/.github/ISSUE_TEMPLATE/bugs.yaml new file mode 100644 index 000000000..deb9be578 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bugs.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/enhancements.yaml b/.github/ISSUE_TEMPLATE/enhancements.yaml new file mode 100644 index 000000000..637bf5495 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancements.yaml @@ -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 diff --git a/.github/PULL_REQUEST_TEMPLATE/prs.md b/.github/PULL_REQUEST_TEMPLATE/prs.md new file mode 100644 index 000000000..24b40161e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/prs.md @@ -0,0 +1,18 @@ + + +**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 + + + +
+ + +Fixes #