You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,24 +7,30 @@ We appreciate your thought to contribute to open source. :heart: We want to make
7
7
- Submitting a fix
8
8
- Proposing new features
9
9
10
-
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
10
+
We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
11
11
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
12
12
13
-
1. Fork the repo and create your branch from `master`.
14
-
2. If you've added code that should be tested, add tests.
15
-
3. If you've changed APIs, update the documentation.
16
-
4. Ensure the test suite passes.
17
-
5. Make sure your code lints.
18
-
6. Issue that pull request!
13
+
1. Fork the repo and create your branch from `develop`.
14
+
2. If you've added code, check one of the examples.
15
+
3. Make sure your code lints.
16
+
4. Raise a pull request.
17
+
18
+
## Terraform version
19
+
20
+
For development the terraform version is locked via [tfenv](https://github.com/tfutils/tfenv).
19
21
20
22
## Coding Style
23
+
21
24
We use the [Terraform Style conventions](https://www.terraform.io/docs/configuration/style.html). They are enforced with CI scripts.
22
25
23
26
## Documentation
27
+
24
28
We use [pre-commit](https://pre-commit.com/) to update the Terraform inputs and outputs in the documentation via [terraform-docs](https://github.com/terraform-docs/terraform-docs). Ensure you have installed those components.
25
29
26
30
## Testing
31
+
27
32
No automated tests are available. The example directory takes care of a few scenario's.
28
33
29
34
## License
35
+
30
36
By contributing, you agree that your contributions will be licensed under its MIT License.
0 commit comments