Merge pull request #45 from covalenthq/precommit

precommit hook for running golangci-lint

Author: noslav

.githooks/pre-commit

@@ -0,0 +1,33 @@
+#!/bin/sh
+
+STAGED_GO_FILES=$(git diff --cached --name-only | grep ".go$")
+
+if [[ "$STAGED_GO_FILES" = "" ]]; then
+  exit 0
+fi
+
+
+if ! command -v golangci-lint &> /dev/null; then
+    printf "installing golangci-lint"
+    brew install golangci-lint
+fi
+
+
+PASS=true
+
+for FILE in $STAGED_GO_FILES
+do
+  golangci-lint run $FILE
+  if [[ $? == 1 ]]; then
+    PASS=false
+  fi
+done
+
+if ! $PASS; then
+  printf "COMMIT FAILED\n"
+  exit 1
+else
+  printf "COMMIT SUCCEEDED\n"
+fi
+
+exit 0

docs/CONTRIBUTING.md

@@ -5,6 +5,7 @@
   * [Development Procedure](#dev_procedure)
   * [Dependencies](#dependencies)
   * [Testing](#testing)
+  * [Linting](#linting)
   * [Branching Model and Release](#braching_model_and_release)
   * [PR Targeting](#pr_targeting)
   * [Pull Requests](#pull_requests)
@@ -88,6 +89,16 @@ on `go mod tidy -v`.
 
 Covalent uses [GitHub Actions](https://github.com/features/actions) for automated [integration testing](https://github.com/covalenthq/bsp-agent/actions).
 
+### <spand id="linting">Linting</span>
+
+The repo uses `golangci-lint` to run linters and enforce coding standards. There are two ways to run this:
+- run `golangci-lint run` or `golangci-lint run <filename>`
+- or configure the git hooks path: 
+```bash
+git config core.hooksPath .githooks
+```  
+This will run `golanci-lint` automatically before committing. 
+
 ### <span id="braching_model_and_release">Branching Model and Release</span>
 
 User-facing repos should adhere to the [trunk based development branching model](https://trunkbaseddevelopment.com/).
@@ -129,4 +140,4 @@ All PRs require two Reviews before merge. When reviewing PRs, please use the fol
 
 1. Ensure pull branch is rebased on `main`.
 2. Ensure that all CI tests pass.
-3. Squash merge pull request.
+3. Squash merge pull request.