Skip to content

Commit 635f1f1

Browse files
authored
docs: enrich PR request template (#120)
1 parent b20f847 commit 635f1f1

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
<!--
2-
check contribution guidelines at https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/CONTRIBUTE.md#contribution-checklist
2+
Thank you for your contribution!
3+
4+
## General recommendations
5+
Check contribution guidelines at https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/CONTRIBUTE.md#contribution-checklist
6+
7+
For a cleaner PR make sure you follow these recommendations:
8+
- Review modified files and delete small changes that were not intended and maybe slip the commit.
9+
- Use Pull Request Drafts for visibility on Work-In-Progress branches and use them on daily mob/pairing for team review
10+
- Unless an external revision is desired, in order to validate or gather some feedback, you are free to merge as long as **validation checks are green-lighted**
11+
12+
## Checklist
13+
14+
- [ ] If `test/fixtures/*/main.tf` files are modified. I have updated:
15+
- [ ] the snippets in the README.md file under root folder.
16+
- [ ] the snippets in the README.md file for the corresponding example.
17+
- [ ] If `examples` folder are modified. I have updated:
18+
- [ ] README.md file with pertinent changes.
19+
- [ ] `test/fixtures/*/main.tf` in case the snippet needs modifications.
20+
- [ ] If any architectural change has been made, I have updated the diagrams.
21+
322
-->
23+

0 commit comments

Comments
 (0)