Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue templates #1

Merged
merged 3 commits into from
Sep 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
name: Bug report
about: Create a report to help us improve
title: 'issue title'
labels: 'bug'
assignees: ''

---

<!-- Thanks for filing an issue!
Before hitting the button, please answer these questions.
It's helpful to search the existing GitHub issues first.
It's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware o.

Fill in as much of the template below as you can.
The more information we have the better we can help you.

Be ready for followup questions, and please respond in a timely manner.
If we can't reproduce a bug or think a feature already exists, we might close your issue.
If we're wrong, PLEASE feel free to reopen it and explain why.
-->

**Describe the bug**
A clear and concise description of what the bug is.

**Version of Helm and Kubernetes**:

Helm Version:

```console
$ helm version
please put the output of it here
```

Kubernetes Version:

```console
$ kubectl version
please put the output of it here
```


**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 {{ .GitHubOrg }}/name-of-chart --version version --values values.yaml
```

-->


**Anything else we need to know**:
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'issue title'
labels: 'enhancement'
assignees: ''

---

<!--
Thanks for filing an issue!
Before hitting the button, please answer these questions.
It's helpful to search the existing GitHub issues first.
It's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of.

Describe *in detail* the feature/behavior/change you'd like to see.

Be ready for followup questions, and please respond in a timely manner.
If we can't reproduce a bug or think a feature already exists, we might close your issue.
If we're wrong, PLEASE feel free to reopen it and explain why.
-->

**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.
41 changes: 41 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!--
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://helm.sh/docs/chart_best_practices/

For a quick overview across what we will look at reviewing your PR, please read our review guidelines:

* https://github.com/helm/charts/blob/master/REVIEW_GUIDELINES.md

Following our best practices right from the start will accelerate the review process and help get your PR merged quicker.

When updates to your PR are requested, please add new commits and do not squash the history.
This will make it easier to identify new changes.
The PR will be squashed anyways when it is merged.
Thanks.

For fast feedback, please @-mention maintainers that are listed in the Chart.yaml file.

Please make sure you test your changes before you push them.
Once pushed, GitHub Actions will run across your changes and do some initial checks and linting.
These checks run very quickly.
Please check the results.
We would like these checks to pass before we even continue reviewing your changes.
-->

# What this PR does / why we need it

# Which issue this PR fixes

*(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*

- fixes #

# Special notes for your reviewer

# Checklist
<!-- [Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
- [ ] [DCO](https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md#sign-off-your-work) signed
- [ ] Chart Version bumped
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -41,7 +40,7 @@ This is basically a summary of helm chart migrations which already took place:
1. `stable/jenkins` to <https://github.com/jenkinsci/helm-charts>
1. `stable/grafana` to <https://github.com/grafana/helm-charts>
That migration was done in about a day.
https://github.com/grafana/helm-charts/issues/3 was used to document the executed steps.
<https://github.com/grafana/helm-charts/issues/3> was used to document the executed steps.
That's helped to write this.

### Prerequisites
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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/`.
Expand Down
4 changes: 2 additions & 2 deletions REPO-README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ You can then run `helm search repo {{ .GitHubOrg }}` to see the charts.
## Contributing

<!-- Keep full URL links to repo files because this README syncs from main to gh-pages. -->
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](<https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/CONTRIBUTING.md>) for details.

## License

<!-- Keep full URL links to repo files because this README syncs from main to gh-pages. -->
[Apache 2.0 License](https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/LICENSE).
[Apache 2.0 License](<https://github.com/{{ .GitHubOrg }}/helm-charts/blob/main/LICENSE>).