Can't we add commit hooks and documentation generation framework to the repo?

[kral2]

Having common git commit hooks and auto-generated documentation for some part of the project would be great. It would give a better consistency and reduce toil.

[kral2]

There are two tools that come at the forefront for such tasks:

• pre-commit to manage Git hooks
• Terraform-docs to generate Terraform modules documentation

These solutions sits at the developer's computer, and helps to lint/correct/sanitize code before it hits any remote repo.

At the moment, we decided to not enforce any setup on developer side and to look for a solution to apply such validations on server side using GitHub Status Checks. This is a space where we need help: If you would like to contribute, please open an Issue to share ideas/suggestions or a PR.

That being said, we can probably suggest a recommended set of tooling and specific configuration that would match the repo's coding conventions.

Examples of pre-commit and terraform-docs configuration files that would work can be found below:

• https://github.com/kral2/hashistack_on_oci/blob/main/.pre-commit-config.yaml
• https://github.com/kral2/hashistack_on_oci/blob/main/.terraform-docs.yml

We may add such template files as suggested configuration in the documentation folder, without enforcing it at the repo's root directory.