We appreciate your thought to contribute to open source. ❤️ We want to make contributing as easy as possible. You are welcome to:
- Report a bug
- Discuss the current state of the code
- Submit a fix
- Propose new features
We use Github Flow, so all code changes happen through pull requests. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code, check one of the examples.
- Make sure your code lints.
- Raise a pull request.
We support Terraform version 1 and above. All checks within the pipeline are usually done with the newest version. If you need different versions of Terraform installed, check tfenv.
We use the Terraform Style conventions. They are enforced with CI scripts.
We use pre-commit to update the Terraform inputs and outputs in the documentation via terraform-docs. Ensure you have installed those components and to update the documentation of the module before raising the PR.
No automated tests are available. The example directory takes care of a few scenario's.
By contributing, you agree that your contributions will be licensed under its Apache 2.0 license.