Skip to content

Commit

Permalink
formatted GitHub templates and made minor adjustments (prometheus-com…
Browse files Browse the repository at this point in the history
…munity#59)

* formatted GitHub templates and made minor adjustments

Signed-off-by: Torsten Walter <mail@torstenwalter.de>
  • Loading branch information
torstenwalter authored Sep 7, 2020
1 parent 6d879b7 commit c5a3f47
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 13 deletions.
41 changes: 38 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,40 @@ 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
<!-- 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. If you leave out information, we can't help you as well.
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.
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 chart**:
**Which version of the chart**:


**What happened**:
Expand All @@ -31,5 +51,20 @@ A clear and concise description of what the bug is.

**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**:
12 changes: 9 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,17 @@ 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.
<!--
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.
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.**
Expand All @@ -24,4 +30,4 @@ A clear and concise description of what you want to happen.
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.
Add any other context or screenshots about the feature request here.
20 changes: 13 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!--
Thank you for contributing to prometheus-community/helm-charts. Before you submit this PR we'd like to make sure you are aware of our technical requirements and best practices:
Thank you for contributing to prometheus-community/helm-charts.
Before you submit this PR we'd like to make sure you are aware of our technical requirements and best practices:
* https://github.com/prometheus-community/helm-charts/blob/main/CONTRIBUTING.md#technical-requirements
* https://helm.sh/docs/chart_best_practices/
Expand All @@ -11,14 +12,19 @@ For a quick overview across what we will look at reviewing your PR, please read
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.
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.
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.
-->
#### Is this a new chart

#### What this PR does / why we need it:

#### Which issue this PR fixes
Expand All @@ -28,7 +34,7 @@ Please make sure you test your changes before you push them. Once pushed, GitHub
#### Special notes for your reviewer:

#### Checklist
[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]
<!-- [Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
- [ ] [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]`)
- [ ] Title of the PR starts with chart name (e.g. `[prometheus-couchdb-exporter]`)

0 comments on commit c5a3f47

Please sign in to comment.