When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
The repository uses pre-commit and pre-commit-terraform hooks to autoformat code and generate documentation before committing changes. Hence, to start contributing, ensure you have
- pre-commit installed.
- terraform-docs installed.
- tflint installed.
$ pre-commit install # Initializes pre-commit
$ git commit -m "<MESSAGE>" # calls pre-commit hooks before commiting changes- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release. The mainteners takes care of updating the CHANGELOG as they merge.
- Add sementics prefix to your PR or Commits (at leats one of your commit groups)
- CI tests are passing
- README.md has been updated after any changes to variables and outputs. See docs generation
To generate changelog, Pull Requests or Commits must have sementic and must follow conventional specs below:
feat:for new featuresfix:for bug fixesimprovement:for enhancementsdocs:for documentation and examplesrefactor:for code refactoringtest:for testsci:for CI purposechore:for chores stuff
The chore prefix skipped during changelog generation. It can be used for chore: update changelog commit message by example.