From 90165ec28fd36359cf42620a364d5c6bd55fb7e9 Mon Sep 17 00:00:00 2001 From: Ellis Tarn Date: Wed, 21 Jun 2023 11:59:56 -0700 Subject: [PATCH] chore: Simplified ISSUE_TEMPLATE (#4098) --- .github/ISSUE_TEMPLATE/bug.yaml | 72 ++++------------------- .github/ISSUE_TEMPLATE/docs-request.yaml | 36 ------------ .github/ISSUE_TEMPLATE/documentation.yaml | 10 ++++ .github/ISSUE_TEMPLATE/feature.yaml | 12 ++++ .github/ISSUE_TEMPLATE/request.yaml | 59 ------------------- 5 files changed, 33 insertions(+), 156 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/docs-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml delete mode 100644 .github/ISSUE_TEMPLATE/request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 732741e3eebf..e73e2a606e4d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -1,68 +1,18 @@ +--- name: Bug Report -description: Report a bug in Karpenter +about: Report a bug +title: '' labels: bug -body: - - type: textarea - id: version - attributes: - label: Version - description: | - https://github.com/aws/karpenter/releases - value: | - - __Karpenter Version:__ v0.0.0 - - __Kubernetes Version:__ v1.0.0 - validations: - required: true +assignees: '' - - type: textarea - id: expected - attributes: - label: Expected Behavior - description: | - Briefly describe what you expected to happen - validations: - required: true +--- - - type: textarea - id: actual - attributes: - label: Actual Behavior - description: | - Briefly describe what is actually happening - validations: - required: true +**Observed Behavior**: - - type: textarea - id: steps - attributes: - label: Steps to Reproduce the Problem - description: | - How can a maintainer reproduce this issue (be detailed)? - validations: - required: true +**Expected Behavior**: - - type: textarea - id: specs-logs - attributes: - label: Resource Specs and Logs - description: | - Include Provisioner spec(s), pod spec(s), and Karpenter controller logs when you experienced the bug - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - validations: - required: true +**Reproduction Steps** (Please include YAML): - - type: textarea - id: community-note - attributes: - label: Community Note - description: | - Please keep this note for the community - value: | - * 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 - * Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment - validations: - required: true +**Versions**: +- Chart Version: +- Kubernetes Version (`kubectl version`): \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/docs-request.yaml b/.github/ISSUE_TEMPLATE/docs-request.yaml deleted file mode 100644 index 8b2b70a0a2ac..000000000000 --- a/.github/ISSUE_TEMPLATE/docs-request.yaml +++ /dev/null @@ -1,36 +0,0 @@ -name: Docs Request/Question -description: All things related to docs! Bugs, requests, suggestions, etc. -labels: Documentation -body: - - type: input - id: existing-page - attributes: - label: Is an existing page relevant? - placeholder: ex. https://karpenter.sh/v0.16.1/upgrade-guide/ - - - type: textarea - id: relevant-features - attributes: - label: What karpenter features are relevant? - validations: - required: true - - - type: textarea - id: docs-improvement - attributes: - label: How should the docs be improved? - validations: - required: true - - - type: textarea - id: community-note - attributes: - label: Community Note - description: | - Please keep this note for the community - value: | - * 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 - * Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment - validations: - required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 000000000000..1bf88b080938 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,10 @@ +--- +name: Documentation +about: How the docs be improved? +title: '' +labels: documentation +assignees: '' + +--- + +**How can the docs be improved?** \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 000000000000..a06d15cd814f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,12 @@ +--- +name: Feature +about: Suggest an idea for a new feature +title: '' +labels: feature +assignees: '' + +--- + +**What problem are you trying to solve?** + +**How important is this feature to you?** \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/request.yaml b/.github/ISSUE_TEMPLATE/request.yaml deleted file mode 100644 index f84138a84fda..000000000000 --- a/.github/ISSUE_TEMPLATE/request.yaml +++ /dev/null @@ -1,59 +0,0 @@ -name: Request -description: Suggest an idea for the roadmap! -labels: feature -body: - - type: textarea - id: feature - attributes: - label: Tell us about your request - description: | - What do you want us to build? - validations: - required: true - - - type: textarea - id: rationale - attributes: - label: Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard? - description: | - 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. - validations: - required: true - - - type: textarea - id: workaround - attributes: - label: Are you currently working around this issue? - description: | - How are you currently solving this problem? - validations: - required: true - - - type: textarea - id: additional - attributes: - label: Additional Context - description: | - Anything else we should know? - - - type: textarea - id: attachments - attributes: - label: Attachments - description: | - 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.) - - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. - - - type: textarea - id: community-note - attributes: - label: Community Note - description: | - Please keep this note for the community - value: | - * 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 - * Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment - validations: - required: true \ No newline at end of file