We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase and we use the Github Flow.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
We use GitHub issues to track public bugs. Report a bug by opening a new issue here.
The CI build will fail on lint issues. To format and run locally execute make lint.
Helpful tip if using an IDE like intelij you can enable file watchers and auto format terraform files.
- terraform-docs - for OSX
brew install terraform-docs
If you add or remove any terraform input or outputs you will need to regenerate the docs and update the README.md sections
make markdown-table