CONTRIBUTING.md

Contributing to Taxi Tribe Infrastructure Admin

Table of contents

• 📦 Prerequisites
• 🚀 Installation
• 🛠️ Local usage for development
• 🤝 Requirements
• 🏗️ Built with

Prerequisites

• Docker or Terraform CLI

Installation

The following command allows to use the Terraform command line via Docker:

docker run --rm -it --name terraform -v ~/:/root/ -v $(pwd):/workspace -w /workspace hashicorp/terraform:light

For simplified use, you can create an alias:

alias terraform='docker run --rm -it --name terraform -v ~/:/root/ -v $(pwd):/workspace -w /workspace hashicorp/terraform:light'

Using this alias, there is no longer any difference between a terraform command executed via Docker or via Terraform CLI.

Local usage for development

Check and fix .tf files format

terraform fmt

Verify ressources consistency

terraform validate

Retrieve Terraform Cloud authentication token locally

terraform login

Initialize state and plugins locally

terraform init

Plan a run to check differences between the current and the next infrastructure state to be deployed

terraform plan

Apply the next state of the infrastructure

terraform apply

Requirements

Branches naming rules

• Must be up-to-date with main (rebased, linear history)
• Must be prefixed with follow the build/, chore/, ci/, docs/, feat/, fix/, perf/, refactor/, revert/, style/ or test/ according to their content. See Conventional Commits cheat sheet

Commits rules

Format

Must follow conventional commits specification: Commits Conventionnels

Verified

Commits must be verified: About commit signature verification

Continuous integration check

All validation checks in workflow Validate Terraform must pass without failure

Built with

Langages & Frameworks

• Terraform is an infrastructure as code software tool that allow to define and provide infrastructure using a declarative configuration language
  • terraform provider: is a Terraform provider used to read and write to/from Terrafrom Cloud (workspaces, variables, etc.)