Skip to content

Commit 271f7dd

Browse files
author
iru
committed
chore(doc): contribute
[skip ci]
1 parent ae6d434 commit 271f7dd

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

CONTRIBUTE.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,34 @@
11
# General
22

3-
- Use conventional commits https://www.conventionalcommits.org/en/v1.0.0/
4-
3+
- Use **conventional commits** | https://www.conventionalcommits.org/en/v1.0.0
4+
- Current suggested **scopes** to be used within feat(scope), fix(scope), ...
5+
- threat
6+
- bench
7+
- scan
8+
- docs
59
- 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
10+
- example diagram-as-code | https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account/diagram-single.py
11+
- resulting diagram | https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/examples/single-account/diagram-single.png
12+
- Utilities
13+
- Useful Terraform development guides | https://www.terraform-best-practices.com
1114

1215

1316

1417
# Pull Request
1518

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-
- Kitchen tests https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/test/integration/kt_suite
19-
19+
- Terraform **lint** and **validation is enforced vía pre-commit** | https://pre-commit.com
20+
- custom configuration | https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/blob/master/.pre-commit-config.yaml
21+
- current `terraform-docs` requires developer to create `README.md` file, with the enclosure tags for docs to insert the automated content
22+
```markdown
23+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
24+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
25+
```
26+
- Kitchen tests | https://github.com/sysdiglabs/terraform-aws-secure-for-cloud/tree/master/test/integration/kt_suite
2027

2128

2229
# Release
2330

24-
- Use semver for releases https://semver.org
31+
- Use **semver** for releases https://semver.org
2532
- Module official releases will be published at terraform registry
2633
- Just create a tag/release and it will be fetched by pre-configured webhook and published into.
2734
- For internal usage, TAGs can be used

0 commit comments

Comments
 (0)