Skip to content

Commit 1b560f0

Browse files
Merge pull request #3 from makandra/sh/style_update
style: update modules to follow our style guide
2 parents 558b3b8 + ff962dc commit 1b560f0

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11

2-
# Contributing
2+
# Contributing
33

44
When contributing to this repository, please first discuss the change you wish to make by opening an issue, and link the pull request.
55

66
# Chores
7+
78
Please read and execute the following tasks, if appropriate, when making a new pull request.
89

910
* Verify checkov passes
1011
* We use [checkov](https://www.checkov.io/) as static code analyzer. You can run checkov locally in docker to avoid installing it, by executing the following command at the repository root level:
12+
1113
```sh
1214
docker run -it --rm --workdir /share -v $PWD:/share:ro bridgecrew/checkov:latest --quiet --compact --directory /share
13-
```
15+
```
16+
1417
* Update `README.md`
15-
* We use `terraform-docs` to create part of the documentation. If you made changes to the terraform code please execute the following command to update the [README.md](README.md):
18+
* We use `terraform-docs` to create part of the documentation. If you made changes to the terraform code please execute the following command to update the [README.md](README.md):
19+
1620
```sh
1721
terraform-docs --output-file README.md markdown .
1822
```
File renamed without changes.

0 commit comments

Comments
 (0)