refactor README.md to CONTRIBUTING.md and examples/

Signed-off-by: Marques Johansson <[email protected]>

CONTRIBUTING.md

@@ -25,6 +25,26 @@ The project has the following folders and files:
 - /CODE_OF_CONDUCT.md: Code of Conduct file.
 - /CONTRIBUTING.md: This file.
 
+## Development
+
+Install [pre-commit](https://pre-commit.com/#install) with its prerequesites: [python](https://docs.python.org/3/using/index.html) and [pip](https://pip.pypa.io/en/stable/installation/).
+
+Configure pre-commit: `pre-commit install`.
+
+Install required packages: [tflint](https://github.com/terraform-linters/tflint), [tfsec](https://aquasecurity.github.io/tfsec/v1.0.11/getting-started/installation/), [shfmt](https://github.com/mvdan/sh), [shellcheck](https://github.com/koalaman/shellcheck), and [markdownlint](https://github.com/markdownlint/markdownlint).
+
+## Module Documentation
+
+The main README.md, the modules README.md and the examples README.md are populated by a [terraform-docs worflow job](.github/workflows/documentation.yaml). The following sections are appended between the terraform-docs delimeters: Requiremenents, Providers, Modules, Resources, Inputs, and Outputs.
+
+## Module Release and Changelog Generation
+
+The module git release and [changelog](CHANGELOG.md) are generated by the [release workflow job](.github/workflows/release.yaml). The release worflow follows the [conventional commits convention](https://www.conventionalcommits.org/). To submit a commit, please follow the [commit message format guidelines](https://www.conventionalcommits.org/en/v1.0.0/#specification). This job is set to run manually by default.
+
+Example commit message: `fix: disabled log generation for system services`
+
+For more examples, please see [conventional commit message examples](https://www.conventionalcommits.org/en/v1.0.0/#examples).
+
 ## Issues and Change Requests
 
 Please submit change requests and / or features via [Issues](https://github.com/equinix-labs/equinix-labs/issues).