CONTRIBUTING.md

Contributing to Big Bang

Thanks for taking the time to contribute to BigBang!

Table of Contents:

• Contributing to Big Bang
  • Developers Guide
  • Local Git Setup
    • Pre-commit hooks
      • Local Setup
        • Prereqs
        • Steps
  • Iron Bank Images
  • Local Kubernetes cluster
  • Deploying Big Bang (Quick Start)
  • Testing Big Bang Development Changes
  • DNS
  • Secrets & Certificates
  • Merge requests process
    • Pipeline Stages
      • Linting
      • Smoke Testing
      • Infrastructure Testing
        • Network Creation
        • Cluster(s) Creation
        • Big Bang Installation
        • Big Bang Tests
      • Teardown

Developers Guide

Big Bang is designed in such a way as to be as easily deployed locally as it is in production. In fact, most contributions begin locally.

Local Git Setup

Pre-commit hooks

We would like developers to leverage conventional commits when contributing. In order to help enforce this we are leveraging client-side pre-commit hooks. This is done using the following tools:

• husky
• commitlint