forked from gruntwork-io/pre-commit
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GitHub PR & Issue Templates (gruntwork-io#63)
- Loading branch information
Showing
3 changed files
with
98 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,33 @@ | ||
--- | ||
name: Bug report | ||
about: Create a bug report to help us improve. | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- | ||
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e, | ||
or ask in this issue and a Gruntwork core maintainer will be happy to help :) | ||
--> | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior including the relevant Terraform/Terragrunt/Packer version number and any code snippets and module inputs you used. | ||
|
||
```hcl | ||
// paste code snippets here | ||
``` | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Nice to have** | ||
- [ ] Terminal output | ||
- [ ] Screenshots | ||
|
||
**Additional context** | ||
Add any other context about the problem 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,22 @@ | ||
--- | ||
name: Feature request | ||
about: Submit a feature request for this repo. | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- | ||
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e, | ||
or ask in this issue and a Gruntwork core maintainer will be happy to help :) | ||
--> | ||
|
||
**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,43 @@ | ||
<!-- | ||
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e, | ||
or ask in this Pull Request and a Gruntwork core maintainer will be happy to help :) | ||
Note: Remember to add '[WIP]' to the beginning of the title if this PR is still a work-in-progress. Remove it when it is ready for review! | ||
--> | ||
|
||
## Description | ||
|
||
<!-- Write a brief description of the changes introduced by this PR --> | ||
|
||
### Documentation | ||
|
||
<!-- | ||
If this is a feature PR, then where is it documented? | ||
- If docs exist: | ||
- Update any references, if relevant. | ||
- If no docs exist: | ||
- Create a stub for documentation including bullet points for how to use the feature, code snippets (including from happy path tests), etc. | ||
--> | ||
|
||
<!-- Important: Did you make any backward incompatible changes? If yes, then you must write a migration guide! --> | ||
|
||
## TODOs | ||
|
||
Please ensure all of these TODOs are completed before asking for a review. | ||
|
||
- [ ] Ensure the branch is named correctly with the issue number. e.g: `feature/new-vpc-endpoints-955` or `bug/missing-count-param-434`. | ||
- [ ] Update the docs. | ||
- [ ] Keep the changes backward compatible where possible. | ||
- [ ] Run the pre-commit checks successfully. | ||
- [ ] Run the relevant tests successfully. | ||
- [ ] Ensure any 3rd party code adheres with our [license policy](https://www.notion.so/gruntwork/Gruntwork-licenses-and-open-source-usage-policy-f7dece1f780341c7b69c1763f22b1378) or delete this line if its not applicable. | ||
|
||
|
||
## Related Issues | ||
|
||
<!-- | ||
Link to related issues, and issues fixed or partially addressed by this PR. | ||
e.g. Fixes #1234 | ||
e.g. Addresses #1234 | ||
e.g. Related to #1234 | ||
--> |