BB-1085-Add pre commits

.gitignore

@@ -2,3 +2,9 @@
 certs/
 
 .DS_Store
+
+# dependencies
+/node_modules
+
+# debug
+npm-debug.log*
\ No newline at end of file

CONTRIBUTING.md

@@ -6,6 +6,11 @@ Table of Contents:
 
 - [Contributing to Big Bang](#contributing-to-big-bang)
   - [Developers Guide](#developers-guide)
+  - [Local Git Setup](#local-git-setup)
+    - [Pre-commit hooks](#pre-commit-hooks)
+      - [Local Setup](#local-setup)
+        - [Prereqs](#prereqs)
+        - [Steps](#steps)
   - [Iron Bank Images](#iron-bank-images)
   - [Local Kubernetes cluster](#local-kubernetes-cluster)
   - [Deploying Big Bang (Quick Start)](#deploying-big-bang-quick-start)
@@ -23,10 +28,35 @@ Table of Contents:
         - [Big Bang Tests](#big-bang-tests)
       - [Teardown](#teardown)
 
-## Developers Guide
+## 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](https://www.conventionalcommits.org/) when contributing. In order to help enforce this we are leveraging client-side pre-commit hooks. This is done using the following tools:
+
+- [husky](https://www.npmjs.com/package/husky)
+- [commitlint](https://commitlint.js.org/#/)
+
+#### Local Setup
+
+##### Prereqs
+
+- Install [npm](https://www.npmjs.com/get-npm)
+
+##### Steps
+
+After cloning this git repo run the following command:
+
+```bash
+npm install --only=dev
+```
+
+This will download `husky` and `commitlint` to your local repo and modify your `.git/hooks` to allow husky to run pre-commit hooks. Once installed it will enforce the usage of convential-commits.
+
 ## Iron Bank Images
 
 Per the [charter](https://repo1.dsop.io/platform-one/big-bang/charter), all Big Bang packages will leverage container images from [IronBank](https://ironbank.dsop.io/).  In order to pull these images, ImagePullSecrets must be provided to BigBang.  To obtain access to these images, follow the guides below.  These steps should NOT be used for production since the API keys for a user are only valid when the user is logged into [Registry1](https://registry1.dsop.io)

commitlint.config.js

+module.exports = {extends: ['@commitlint/config-conventional']};

package.json

+{
+  "name": "umbrella",
+  "description": "Big Bang is a declarative, continuous delivery tool for core DoD hardened and approved [packages](#packages) into a Kubernetes cluster.  Big Bang follows a [GitOps](#gitops) approach to configuration management, using [Flux v2](#flux-v2) to reconcile Git with the cluster.  Environments (e.g. dev, prod) and packages (e.g. istio) can be fully configured to suit the deployment needs.",
+  "repository": {
+    "type": "git",
+    "url": "https://repo1.dso.mil/platform-one/big-bang/umbrella.git"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
+    "husky": "^3.0.0"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  }
+}