Skip to content

Commit 4d2be56

Browse files
authored
Add GitHub PR & Issue Templates (gruntwork-io#63)
1 parent 1722bf6 commit 4d2be56

File tree

3 files changed

+98
-0
lines changed

3 files changed

+98
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
12+
or ask in this issue and a Gruntwork core maintainer will be happy to help :)
13+
-->
14+
15+
**Describe the bug**
16+
A clear and concise description of what the bug is.
17+
18+
**To Reproduce**
19+
Steps to reproduce the behavior including the relevant Terraform/Terragrunt/Packer version number and any code snippets and module inputs you used.
20+
21+
```hcl
22+
// paste code snippets here
23+
```
24+
25+
**Expected behavior**
26+
A clear and concise description of what you expected to happen.
27+
28+
**Nice to have**
29+
- [ ] Terminal output
30+
- [ ] Screenshots
31+
32+
**Additional context**
33+
Add any other context about the problem here.
+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Submit a feature request for this repo.
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
12+
or ask in this issue and a Gruntwork core maintainer will be happy to help :)
13+
-->
14+
15+
**Describe the solution you'd like**
16+
A clear and concise description of what you want to happen.
17+
18+
**Describe alternatives you've considered**
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
**Additional context**
22+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!--
2+
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
3+
or ask in this Pull Request and a Gruntwork core maintainer will be happy to help :)
4+
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!
5+
-->
6+
7+
## Description
8+
9+
<!-- Write a brief description of the changes introduced by this PR -->
10+
11+
### Documentation
12+
13+
<!--
14+
If this is a feature PR, then where is it documented?
15+
16+
- If docs exist:
17+
- Update any references, if relevant.
18+
- If no docs exist:
19+
- Create a stub for documentation including bullet points for how to use the feature, code snippets (including from happy path tests), etc.
20+
-->
21+
22+
<!-- Important: Did you make any backward incompatible changes? If yes, then you must write a migration guide! -->
23+
24+
## TODOs
25+
26+
Please ensure all of these TODOs are completed before asking for a review.
27+
28+
- [ ] Ensure the branch is named correctly with the issue number. e.g: `feature/new-vpc-endpoints-955` or `bug/missing-count-param-434`.
29+
- [ ] Update the docs.
30+
- [ ] Keep the changes backward compatible where possible.
31+
- [ ] Run the pre-commit checks successfully.
32+
- [ ] Run the relevant tests successfully.
33+
- [ ] 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.
34+
35+
36+
## Related Issues
37+
38+
<!--
39+
Link to related issues, and issues fixed or partially addressed by this PR.
40+
e.g. Fixes #1234
41+
e.g. Addresses #1234
42+
e.g. Related to #1234
43+
-->

0 commit comments

Comments
 (0)