From ba0ae9decbe9f2ef42283b5c3bed2f196fa95bd1 Mon Sep 17 00:00:00 2001 From: michaelfitzo Date: Thu, 12 Dec 2024 11:18:59 -0600 Subject: [PATCH 1/3] adding a new issues template --- .../create-a-bug-report-helm.md | 66 +++++++++++++++++++ .../create-a-feature-request.md | 22 +++++++ 2 files changed, 88 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/create-a-bug-report-helm.md create mode 100644 .github/ISSUE_TEMPLATE/create-a-feature-request.md diff --git a/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.md b/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.md new file mode 100644 index 00000000..6fdff74f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.md @@ -0,0 +1,66 @@ +--- +name: Bug Report +description: Use this template for reporting bugs related to gen3-helm. +labels: bug +assignees: [] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to create an issue. Please read the following before posting: + + - DO NOT post any Personally Identifiable Information (PII) in a GitHub Issue. This includes IP address, hostnames, and tokens. + - If you have questions please ask on our [Gen3 Community Slack channel](https://app.slack.com/client/T03A08KRA/C03A08KRY)! Not yet in the channel? Request Slack access [here](https://docs.google.com/forms/d/e/1FAIpQLSczyhhOXeCK9FdVtpQpelOHYnRj1EAq1rwwnm9q6cPAe5a7ug/viewform). + - For bugs, specify impacted services (if known), versions, errors, and explain in detail what you are trying to do. Please provide a minimally reproducible example. + - Issue or Pull Request? Create only one, not both. If unsure, start with an issue or ask on Slack. + + - type: input + attributes: + label: "Name and Version" + description: "Name and version of the affected chart" + placeholder: "gen3-helm release 494" + validations: + required: true + + - type: dropdown + attributes: + label: "What architecture are you using?" + description: "Choose the architecture of the host where the containers are executed" + options: + - amd64 + - arm64 + + - type: textarea + attributes: + label: "What steps will reproduce the bug?" + description: "Enter details about your bug." + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + + - type: textarea + attributes: + label: "Are you using any custom parameters or values?" + description: "Add any parameter used via `--set` or as a `values.yaml` customization." + + - type: textarea + attributes: + label: "What is the expected behavior?" + description: "If possible please provide textual output instead of screenshots." + + - type: textarea + attributes: + label: "What do you see instead?" + description: "If possible please provide textual output instead of screenshots." + validations: + required: true + + - type: textarea + attributes: + label: "Additional information" + description: "Tell us anything you think we should know" diff --git a/.github/ISSUE_TEMPLATE/create-a-feature-request.md b/.github/ISSUE_TEMPLATE/create-a-feature-request.md new file mode 100644 index 00000000..7cd0a6b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/create-a-feature-request.md @@ -0,0 +1,22 @@ +--- +name: Create a Feature Request +about: Suggest an idea for Gen3 +title: 'Feature Request: short description of your feature request' +labels: '' +assignees: '' + +--- + +DO NOT post any Personally Identifiable Information (PII) in a GitHub Issue. This includes IP address and hostnames. + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From cb1b0cbb4ef3ac67ea2599fd2e0bbf175ccefb0b Mon Sep 17 00:00:00 2001 From: michaelfitzo Date: Thu, 12 Dec 2024 11:22:16 -0600 Subject: [PATCH 2/3] change format of file --- .../{create-a-bug-report-helm.md => create-a-bug-report-helm.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{create-a-bug-report-helm.md => create-a-bug-report-helm.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.md b/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/create-a-bug-report-helm.md rename to .github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml From 9a580cc134c113bb6b5d12109945e49183ee3602 Mon Sep 17 00:00:00 2001 From: michaelfitzo Date: Thu, 12 Dec 2024 12:34:53 -0600 Subject: [PATCH 3/3] small update to template --- .github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml b/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml index 6fdff74f..2da79914 100644 --- a/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml +++ b/.github/ISSUE_TEMPLATE/create-a-bug-report-helm.yml @@ -43,15 +43,23 @@ body: validations: required: true + - type: textarea + attributes: + label: "What kind of cluster are you using? (e.g. Kind, Minikube, EKS, GKE, etc.)" + - type: textarea attributes: label: "Are you using any custom parameters or values?" description: "Add any parameter used via `--set` or as a `values.yaml` customization." + validations: + required: true - type: textarea attributes: label: "What is the expected behavior?" description: "If possible please provide textual output instead of screenshots." + validations: + required: true - type: textarea attributes: