Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.76 KB

DEVELOPMENT.md

File metadata and controls

42 lines (28 loc) · 1.76 KB

Development

This doc describes how to setup a local development environment so you can get started contributing to baikonur-oss project.

Follow the instructions below to setup your local development environment. Once you complete the following items, you can make changes to baikonur-oss modules.

Install requirements

You must install the following tools:

  • Terraform: Infrastructure as Code tools for automating deployment
    • Currently, all modules are built on top of the Terraform v0.11.x, so you must pick up the latest version from v0.11 releases
  • terraform-docs: A utility to generate documentation from Terraform modules
  • pre-commit: A framework for running Git hook automatically on every commit

Checkout the reporitory

To checkout this repository:

  1. Create your own fork of a repository
  2. Clone it into your local machine:
git clone [email protected]:${YOUR_GITHUB_USERNAME}/${BAIKONUR_MODULE_NAME}.git
cd ${BAIKONUR_MODULE_NAME}
git remote add upstream [email protected]:baikonur-oss/${BAIKONUR_MODULE_NAME}.git
git remote set-url --push upstream no_push

We recommend to add the upstream remote for regulary syncing your fork.

Install pre-commit hooks

Activate the pre-commit hook and have the following benefits before committing the changes:

  • Apply terraform format
  • Automatically generate inputs/outputs doc sections in README based on variables, outputs declarations
cd ${BAIKONUR_MODULE_NAME}
pre-commit install