From c244a7fb179116706bb3bd6c76909ba271ac599e Mon Sep 17 00:00:00 2001 From: Torsten Walter Date: Mon, 7 Sep 2020 18:20:13 +0200 Subject: [PATCH 1/3] add issue and pull request templates Signed-off-by: Torsten Walter --- .github/ISSUE_TEMPLATE/bug_report.md | 72 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 33 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 40 +++++++++++++ README.md | 6 ++ 4 files changed, 151 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..cda76e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,72 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[name of the chart e.g. prometheus-kube-stack] issue title' +labels: 'bug' +assignees: '' + +--- + + + +**Describe the bug** +A clear and concise description of what the bug is. + +**Version of Helm and Kubernetes**: + +Helm Version: + +``` +$ helm version +please put the output of it here +``` + +Kubernetes Version: + +```console +$ kubectl version +please put the output of it here +``` + + + +**Which chart**: +**Which version of the chart**: + + +**What happened**: + + +**What you expected to happen**: + + +**How to reproduce it** (as minimally and precisely as possible): + +<~-- +This could be something like: + +values.yaml (only put values which differ from the defaults) + +``` +key: value +``` + +``` +helm install my-release prometheus-community/name-of-chart --version version --values values.yaml +``` + +--> + + +**Anything else we need to know**: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..86a820c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[name of the chart e.g. prometheus-couchdb-exporter] issue title' +labels: 'enhancement' +assignees: '' + +--- + + + +**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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..572496c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,40 @@ + +#### What this PR does / why we need it: + +#### Which issue this PR fixes +*(optional, in `fixes #(, fixes #, ...)` format, will close that issue when PR gets merged)* + - fixes # + +#### Special notes for your reviewer: + +#### Checklist + +- [ ] [DCO](https://github.com/prometheus-community/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed +- [ ] Chart Version bumped +- [ ] Title of the PR starts with chart name (e.g. `[prometheus-couchdb-exporter]`) diff --git a/README.md b/README.md index 01dd9ab..88e59da 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,12 @@ This is basically a summary of helm chart migrations which already took place: You can rename `REPO-README.md` to `README.md`. The file contains some placeholders, which need to be replaced. +1. GitHub issue and pull request templates + + - [bug report](./ISSUE_TEMPLATE/bug_report.md) + - [feature request](./ISSUE_TEMPLATE/feature_request.md) + - [pull request](./PULL_REQUEST_TEMPLATE.md) + 1. GitHub Workflows These are the files in `.github/workflows/`. From 563550504647ef46953c99aac40c0c13f3c90464 Mon Sep 17 00:00:00 2001 From: Torsten Walter Date: Mon, 7 Sep 2020 18:29:37 +0200 Subject: [PATCH 2/3] add issue and pull request templates Signed-off-by: Torsten Walter --- .github/ISSUE_TEMPLATE/bug_report.md | 6 ++---- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 18 ++++++++++-------- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cda76e6..eb7b6b1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve -title: '[name of the chart e.g. prometheus-kube-stack] issue title' +title: 'issue title' labels: 'bug' assignees: '' @@ -27,7 +27,7 @@ A clear and concise description of what the bug is. Helm Version: -``` +```console $ helm version please put the output of it here ``` @@ -40,8 +40,6 @@ please put the output of it here ``` - -**Which chart**: **Which version of the chart**: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 86a820c..f27dac7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature request about: Suggest an idea for this project -title: '[name of the chart e.g. prometheus-couchdb-exporter] issue title' +title: 'issue title' labels: 'enhancement' assignees: '' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 572496c..0c6fc41 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,12 @@ -#### What this PR does / why we need it: -#### Which issue this PR fixes +# What this PR does / why we need it + +# Which issue this PR fixes + *(optional, in `fixes #(, fixes #, ...)` format, will close that issue when PR gets merged)* - - fixes # -#### Special notes for your reviewer: +- fixes # + +# Special notes for your reviewer: -#### Checklist +# Checklist - [ ] [DCO](https://github.com/prometheus-community/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed - [ ] Chart Version bumped From fff8e2f1d3e71c4d4da4e74791632717015b46f8 Mon Sep 17 00:00:00 2001 From: Torsten Walter Date: Tue, 8 Sep 2020 14:16:08 +0200 Subject: [PATCH 3/3] fix linting issues - remove prometheus references Signed-off-by: Torsten Walter --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 7 +++---- README.md | 8 ++++---- REPO-README.md | 4 ++-- 4 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index eb7b6b1..58abc7d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -61,7 +61,7 @@ key: value ``` ``` -helm install my-release prometheus-community/name-of-chart --version version --values values.yaml +helm install my-release {{ .GitHubOrg }}/name-of-chart --version version --values values.yaml ``` --> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0c6fc41..49a1b25 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ Thank you for contributing! Before you submit this PR we'd like to make sure you are aware of our technical requirements and best practices: -* https://github.com/{{ .GitHubOrg }}helm-charts/blob/main/CONTRIBUTING.md#technical-requirements +* https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md#technical-requirements * https://helm.sh/docs/chart_best_practices/ For a quick overview across what we will look at reviewing your PR, please read our review guidelines: @@ -33,10 +33,9 @@ We would like these checks to pass before we even continue reviewing your change - fixes # -# Special notes for your reviewer: +# Special notes for your reviewer # Checklist -- [ ] [DCO](https://github.com/prometheus-community/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed +- [ ] [DCO](https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed - [ ] Chart Version bumped -- [ ] Title of the PR starts with chart name (e.g. `[prometheus-couchdb-exporter]`) diff --git a/README.md b/README.md index 88e59da..838bcfd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ This repository contains templates which can be used to host your own [Helm](https://helm.sh/) chart repository on GitHub. - Hosting your own charts on GitHub has become very easy as there are many GitHub Actions which can be used to set everything up. This repository contains ready to use Github Workflows to @@ -41,7 +40,7 @@ This is basically a summary of helm chart migrations which already took place: 1. `stable/jenkins` to 1. `stable/grafana` to That migration was done in about a day. - https://github.com/grafana/helm-charts/issues/3 was used to document the executed steps. + was used to document the executed steps. That's helped to write this. ### Prerequisites @@ -57,6 +56,7 @@ This is basically a summary of helm chart migrations which already took place: ```shell brew install git-filter-repo ``` + - an empty repository in GitHub where the chart should be migrated to ### Migration Steps @@ -82,7 +82,7 @@ This is basically a summary of helm chart migrations which already took place: git filter-repo --path-glob 'stable/grafana/*' --path-rename stable/:charts/ ``` -1. Push the repository to it's new location +1. Push the repository to it's new location ```shell git checkout -b main @@ -153,7 +153,7 @@ This is basically a summary of helm chart migrations which already took place: CONTRIBUTING.md is a standard contribution template. That should serve as a starting point. If you want to enforce DCO check then [DCO](https://github.com/apps/dco) GitHub App could be used for that. - If you don't want DCO then also remove it from contributing guidelines. + If you don't want DCO then also remove it from contributing guidelines. 1. Code of Conduct diff --git a/REPO-README.md b/REPO-README.md index cd44562..c9f83e5 100644 --- a/REPO-README.md +++ b/REPO-README.md @@ -20,9 +20,9 @@ You can then run `helm search repo {{ .GitHubOrg }}` to see the charts. ## Contributing -We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md) for details. +We'd love to have you contribute! Please refer to our [contribution guidelines]() for details. ## License -[Apache 2.0 License](https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/LICENSE). +[Apache 2.0 License]().