Contribution guide

October 5, 2023 ยท View on GitHub

We appreciate your thought to contribute to open source. :heart: 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:

  1. Fork the repo and create your branch from main.
  2. If you've added code, check one of the examples.
  3. Make sure your code lints.
  4. Raise a pull request.

Terraform version

For development the terraform version is locked via tfenv.

Coding Style

We use the Terraform Style conventions. They are enforced with CI scripts.

Documentation

We use pre-commit to update the Terraform inputs and outputs in the documentation via terraform-docs. Ensure you have installed those components.

Testing

No automated tests are available. The example directory takes care of a few scenario's.

License

By contributing, you agree that your contributions will be licensed under its MIT License.