Skip to content

Commit

Permalink
Improve pull_request_template and doccument
Browse files Browse the repository at this point in the history
"inline documentation" conventions
  • Loading branch information
ttarczynski committed Aug 3, 2021
1 parent 949fed8 commit 024a3ac
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
8 changes: 5 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
Resolves issue #
Link issues resolved by this:
Resolves #

Changes/added features:
-
-
-

The following short checklist should be used to make sure your PR is of good quality, and can be merged easily:
- [ ] follows [project conventions](https://github.com/ContainerSolutions/terraform-examples#conventions)
- [ ] follows [project principles](https://github.com/ContainerSolutions/terraform-examples#principles)
- [ ] `./run.sh` works correctly for all new examples
- [ ] CI checks pass
- [ ] mergeable to main
- [ ] mergeable to main (no conflicts)
- [ ] resolved issues linked

Reviewers:
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ The examples seek to be:
- For help with automated testing
- where possible, add some way to enable 'left-over' resources to be cleaned up, eg provider `default_tags` of `cs_terraform_examples` in AWS provider blocks

- Add inline documentation for each Terraform code block
- `# Summary:` – 1-line summary of what this example does
- `# Documentation:` – add link to documentation before each block (terraform, provider, variable, resource, etc.)
- `# Explanation:` – add only where some extra explanation is needed

## GitHub Actions Workflow

On every commit, the following tests run on all branches:
Expand Down

0 comments on commit 024a3ac

Please sign in to comment.