Skip to content

Commit 6ece24b

Browse files
author
iru
committed
chore: add contrib
1 parent 0293d23 commit 6ece24b

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# General
2+
3+
- Use conventional commits https://www.conventionalcommits.org/en/v1.0.0/
4+
5+
- Maintain example **diagrams** for a better understanding of the architecture and sysdig secure resources
6+
- example diagram-as-code https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account/diagram-single.py
7+
- resulting diagram https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account/diagram-single.png
8+
9+
- Useful Terraform development guides
10+
- https://www.terraform-best-practices.com
11+
12+
13+
14+
# Pull Request
15+
16+
- Terraform lint and validation is enforced vía https://pre-commit.com
17+
- custom configuration at https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/.pre-commit-config.yaml
18+
- Testing (WIP)
19+
20+
21+
22+
# Release
23+
24+
- Use semver for releases https://semver.org
25+
- Module official releases will be published at terraform registry
26+
- Just create a tag/release and it will be fetched by pre-configured webhook and published into.
27+
- For internal usage, TAGs can be used
28+
- For officual verions, RELEASEs will be used, with its corresponding changelog description.

0 commit comments

Comments
 (0)