forked from particuleio/terraform-kubernetes-addons
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add new issues templates (particuleio#32)
* chore: add new issues templates Signed-off-by: Kevin Lefevre <[email protected]> * chore: add contributing guide Signed-off-by: Kevin Lefevre <[email protected]>
- Loading branch information
1 parent
40bacf5
commit becf205
Showing
5 changed files
with
105 additions
and
0 deletions.
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,34 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, | ||
email, or any other method with the owners of this repository before making a change. | ||
|
||
Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
|
||
## Pull Request Process | ||
|
||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. | ||
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters. | ||
3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will trigger a new release | ||
|
||
## Checklists for contributions | ||
|
||
- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits (at least one of your commit groups) | ||
- [ ] CI tests are passing | ||
- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-eks/#doc-generation | ||
|
||
## Semantic Pull Requests | ||
|
||
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below: | ||
|
||
- `feat:` for new features | ||
- `fix:` for bug fixes | ||
- `improvement:` for enhancements | ||
- `docs:` for documentation and examples | ||
- `refactor:` for code refactoring | ||
- `test:` for tests | ||
- `ci:` for CI purpose | ||
- `chore:` for chores stuff | ||
|
||
The `chore` prefix skipped during changelog generation. It can be used for `chore: update changelog` commit message by example. | ||
|
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,33 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "[bug]" | ||
labels: bug | ||
assignees: ArchiFleKs | ||
|
||
--- | ||
|
||
## Describe the bug | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
## What is the current behavior? | ||
|
||
|
||
## How to reproduce? Please include a code sample if relevant. | ||
|
||
|
||
## What's the expected behavior? | ||
|
||
|
||
## Are you able to fix this problem and submit a PR? Link here if you have already. | ||
|
||
|
||
## Environment details | ||
|
||
* Affected module version: | ||
* OS: | ||
* Terraform version: | ||
* Kubernetes version | ||
|
||
## Any other relevant info |
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,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "[enhancement]" | ||
labels: enhancement | ||
assignees: ArchiFleKs | ||
|
||
--- | ||
|
||
**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,10 @@ | ||
# Pull request title | ||
|
||
## Description | ||
|
||
Please explain the changes you made here and link to any relevant issues. | ||
|
||
### Checklist | ||
|
||
- [ ] CI tests are passing | ||
- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/particuleio/terraform-kubernetes-addons/#doc-generation |
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