-
Notifications
You must be signed in to change notification settings - Fork 5k
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
feat: adding issue templates #54
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
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: '' | ||
|
||
--- | ||
|
||
<!-- 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 | ||
|
||
Fill in as much of the template below as you can. If you leave out information, we can't help you as well. | ||
|
||
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**: | ||
|
||
|
||
**Which chart**: | ||
|
||
|
||
**What happened**: | ||
|
||
|
||
**What you expected to happen**: | ||
|
||
|
||
**How to reproduce it** (as minimally and precisely as possible): | ||
|
||
|
||
**Anything else we need to know**: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
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: '' | ||
|
||
--- | ||
|
||
<!-- 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
<!-- | ||
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/ | ||
|
||
For a quick overview across what we will look at reviewing your PR, please read our review guidelines: | ||
|
||
// TODO: add a REVIEW_GUIDELINES.md in prometheus-community/helm-charts | ||
* 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. | ||
--> | ||
#### Is this a new chart | ||
|
||
#### 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/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]`) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@scottrigby @torstenwalter I have added a TODO comment here to add the review guidelines for prometheus-community/helm-charts. For now, this will refer the helm/charts' guidelines in the PR