From ab5084e0660a9d8014669b0c177787ee6fb2ea40 Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 26 May 2025 10:56:52 +0530 Subject: [PATCH 01/10] Create bug.md Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/bug.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 000000000..386fa2ba8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Share about things that are not working as expected +labels: kind/bug + +--- + +**What happened (please include outputs or screenshots)**: + +**What you expected to happen**: + +**How to reproduce it (as minimally and precisely as possible)**: + +**Anything else we need to know?**: + +**Environment**: +- Kubernetes version (`kubectl version`): +- OS (e.g., MacOS 10.13.6): +- Python version (`python --version`) +- helm version From 61e313908f520ce8915dcad855cf873374258c47 Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 26 May 2025 10:58:51 +0530 Subject: [PATCH 02/10] Added issue templates for documentation & features Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/documentation.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/feature.md | 10 ++++++++++ 2 files changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..75bef6b7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,10 @@ +--- +name: Documentation +about: Report any mistakes or missing information from the documentation or the examples +labels: kind/documentation + +--- + +**Link to the issue (please include a link to the specific documentation or example)**: + +**Description of the issue (please include outputs or screenshots if possible)**: diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 000000000..466b4f87b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,10 @@ +--- +name: Feature request +about: Suggest a new feature for the project +labels: kind/feature + +--- + +**What is the feature and why do you need it**: + +**Describe the solution you'd like to see**: From fcef3131971ebb045994d885116dbd53112a3434 Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 26 May 2025 11:05:07 +0530 Subject: [PATCH 03/10] Delete .github/issue_template.md Signed-off-by: Bhargavkonidena --- .github/issue_template.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 .github/issue_template.md diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 48f48e5b6..000000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,9 +0,0 @@ - - -Output of `helm version`: - -Output of `kubectl version`: - -Cloud Provider/Platform (AKS, GKE, Minikube etc.): - - From 03d8e1eaf2b82b74284f7bda83633e8fdff495e0 Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 26 May 2025 11:07:52 +0530 Subject: [PATCH 04/10] Update and rename bug.md to bug-report.yaml Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/bug-report.yaml | 80 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug.md | 20 ------- 2 files changed, 80 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..99c18fc16 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,80 @@ +name: Bug Report +description: Report a bug encountered while operating helm +labels: kind/bug +body: + - type: textarea + id: problem + attributes: + label: What happened? + description: | + Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: What did you expect to happen? + validations: + required: true + + - type: textarea + id: repro + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + validations: + required: true + + - type: textarea + id: additional + attributes: + label: Anything else we need to know? + + - type: textarea + id: kubeVersion + attributes: + label: Kubernetes version + value: | +
+ + ```console + $ kubectl version + # paste output here + ``` + +
+ validations: + required: true + + - type: textarea + id: cloudProvider + attributes: + label: Cloud provider + value: | +
+ +
+ validations: + required: true + + - type: textarea + id: osVersion + attributes: + label: OS version + value: | +
+ + ```console + # On Linux: + $ cat /etc/os-release + # paste output here + $ uname -a + # paste output here + + # On Windows: + C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture + # paste output here + ``` + +
+ diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 386fa2ba8..000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Bug report -about: Share about things that are not working as expected -labels: kind/bug - ---- - -**What happened (please include outputs or screenshots)**: - -**What you expected to happen**: - -**How to reproduce it (as minimally and precisely as possible)**: - -**Anything else we need to know?**: - -**Environment**: -- Kubernetes version (`kubectl version`): -- OS (e.g., MacOS 10.13.6): -- Python version (`python --version`) -- helm version From ca89ae2d7aa7edf0cfa1c70bf009ebba8ba9808e Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 26 May 2025 11:09:05 +0530 Subject: [PATCH 05/10] Update and rename feature.md to feature.yaml Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/feature.md | 10 ---------- .github/ISSUE_TEMPLATE/feature.yaml | 20 ++++++++++++++++++++ 2 files changed, 20 insertions(+), 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 466b4f87b..000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feature request -about: Suggest a new feature for the project -labels: kind/feature - ---- - -**What is the feature and why do you need it**: - -**Describe the solution you'd like to see**: diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 000000000..a4dfef621 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,20 @@ +name: Enhancement Tracking Issue +description: Provide supporting details for a feature in development +labels: kind/feature +body: + - type: textarea + id: feature + attributes: + label: What would you like to be added? + description: | + Feature requests are unlikely to make progress as issues. + A proposal that works through the design along with the implications of the change can be opened as a KEP. + validations: + required: true + + - type: textarea + id: rationale + attributes: + label: Why is this needed? + validations: + required: true From 94318741e5bf672062afbaa4b8fb740856f99cfa Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 26 May 2025 11:10:30 +0530 Subject: [PATCH 06/10] Update and rename documentation.md to documentation.yaml Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/documentation.md | 10 ---------- .github/ISSUE_TEMPLATE/documentation.yaml | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 75bef6b7d..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Documentation -about: Report any mistakes or missing information from the documentation or the examples -labels: kind/documentation - ---- - -**Link to the issue (please include a link to the specific documentation or example)**: - -**Description of the issue (please include outputs or screenshots if possible)**: diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 000000000..32ddd8cac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,19 @@ +name: Documentation +description: Report any mistakes or missing information from the documentation or the examples +labels: kind/documentation +body: + - type: textarea + id: feature + attributes: + label: What would you like to be added? + description: | + Link to the issue (please include a link to the specific documentation or example). + validations: + required: true + + - type: textarea + id: rationale + attributes: + label: Why is this needed? + validations: + required: true From 372dc303685a6f13c29391fa2b97e95af16518d2 Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Wed, 4 Jun 2025 18:28:42 +0530 Subject: [PATCH 07/10] Incorporated review comments Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/bug-report.yaml | 26 ++--------------------- .github/ISSUE_TEMPLATE/documentation.yaml | 8 +++++++ .github/ISSUE_TEMPLATE/feature.yaml | 5 +++-- 3 files changed, 13 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 99c18fc16..b133f872e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,5 +1,5 @@ name: Bug Report -description: Report a bug encountered while operating helm +description: Report a bug encountered in Helm labels: kind/bug body: - type: textarea @@ -49,32 +49,10 @@ body: - type: textarea id: cloudProvider attributes: - label: Cloud provider + label: Cloud provider/platform (AKS, GKE, Minikube etc.) value: |
validations: required: true - - - type: textarea - id: osVersion - attributes: - label: OS version - value: | -
- - ```console - # On Linux: - $ cat /etc/os-release - # paste output here - $ uname -a - # paste output here - - # On Windows: - C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture - # paste output here - ``` - -
- diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index 32ddd8cac..bb1b7537c 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -2,12 +2,19 @@ name: Documentation description: Report any mistakes or missing information from the documentation or the examples labels: kind/documentation body: + - type: markdown + attributes: + value: | + ⚠️ **Note**: Most documentation lives in [helm/helm-www](https://github.com/helm/helm-www). + If your issue is about Helm website documentation or examples, please [open an issue there](https://github.com/helm/helm-www/issues/new/choose). + - type: textarea id: feature attributes: label: What would you like to be added? description: | Link to the issue (please include a link to the specific documentation or example). + Link to the issue raised in [Helm Documentation Improvement Proposal](https://github.com/helm/helm-www) validations: required: true @@ -17,3 +24,4 @@ body: label: Why is this needed? validations: required: true + diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml index a4dfef621..45b9c3f94 100644 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -1,4 +1,4 @@ -name: Enhancement Tracking Issue +name: Enhancement/feature description: Provide supporting details for a feature in development labels: kind/feature body: @@ -8,7 +8,8 @@ body: label: What would you like to be added? description: | Feature requests are unlikely to make progress as issues. - A proposal that works through the design along with the implications of the change can be opened as a KEP. + Initial discussion and ideas can happen on an issue. + But significant changes or features must be proposed as a [Helm Improvement Proposal](https://github.com/helm/community/blob/main/hips/hip-0001.md) (HIP) validations: required: true From 210e29d489fed86b59b6925106ba10fb7cd1fa7c Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 9 Jun 2025 08:55:35 +0530 Subject: [PATCH 08/10] Update bug-report.yaml Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/bug-report.yaml | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index b133f872e..42961b70e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -22,9 +22,23 @@ body: id: repro attributes: label: How can we reproduce it (as minimally and precisely as possible)? + description: | + Please list steps someone can follow to trigger the issue. + + For example: + 1. Run `helm install mychart ./path-to-chart -f values.yaml` + 2. Observe the following error: ... + + You can include: + - a sample `values.yaml` block + - a link to a chart + - specific `helm` commands used + + This helps others reproduce and debug your issue more effectively. validations: required: true + - type: textarea id: additional attributes: @@ -45,14 +59,3 @@ body: validations: required: true - - - type: textarea - id: cloudProvider - attributes: - label: Cloud provider/platform (AKS, GKE, Minikube etc.) - value: | -
- -
- validations: - required: true From b9008b2caa4c3914a115e5ebd26dc2ca097ad53a Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Mon, 9 Jun 2025 17:59:12 +0530 Subject: [PATCH 09/10] Update bug-report.yaml Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/bug-report.yaml | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 42961b70e..950c2a66c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -38,11 +38,19 @@ body: validations: required: true - - type: textarea - id: additional + id: helmVersion attributes: - label: Anything else we need to know? + label: Helm version + value: | +
+ ```console + $ helm version + # paste output here + ``` +
+ validations: + required: true - type: textarea id: kubeVersion From a5084dc0a794d452a7c49ca5e3cfbd56572b1a45 Mon Sep 17 00:00:00 2001 From: Bhargavkonidena Date: Sun, 15 Jun 2025 19:24:49 +0530 Subject: [PATCH 10/10] Update bug-report.yaml Signed-off-by: Bhargavkonidena --- .github/ISSUE_TEMPLATE/bug-report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 950c2a66c..4309d800b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -26,7 +26,7 @@ body: Please list steps someone can follow to trigger the issue. For example: - 1. Run `helm install mychart ./path-to-chart -f values.yaml` + 1. Run `helm install mychart ./path-to-chart -f values.yaml --debug` 2. Observe the following error: ... You can include: