From c3b2af06a76d5b15c7c0c30fa159d0e3d05ebdbc Mon Sep 17 00:00:00 2001
From: Kris Coleman <kriscodeman@gmail.com>
Date: Sat, 5 Apr 2025 16:19:24 -0400
Subject: [PATCH] feat: integrates pre-commit and pre-push hooks to automate
 standards

Adds Lefthook configuration to automate Git hooks, ensuring consistent pre-commit & pre-push checks.

Lefthook automates pre-commit checks such as code formatting and pre-push checks to ensure documentation and tests are up-to-date.

This helps maintain code quality and consistency across the team. I find this saves me time as I switch projects and standards, so I don't push and wait for a PR check to fail.

Signed-off-by: Kris Coleman <kriscodeman@gmail.com>
---
 CONTRIBUTING.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++
 Makefile        |  9 +++++++--
 lefthook.yml    | 21 +++++++++++++++++++
 3 files changed, 82 insertions(+), 2 deletions(-)
 create mode 100644 lefthook.yml

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4f0c385..0359bd3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,7 @@
+# Contributing to OpenFeature CLI
+
+Thank you for your interest in contributing to the OpenFeature CLI! This document provides guidelines and instructions to help you get started with contributing to the project. Whether you're fixing a bug, adding a new feature, or improving documentation, your contributions are greatly appreciated.
+
 ## Contributing New Generators
 
 We welcome contributions for new generators to extend the functionality of the OpenFeature CLI. Below are the steps to contribute a new generator:
@@ -42,6 +46,7 @@ make test-csharp
 ```
 
 This will:
+
 1. Build the CLI
 2. Generate a C# client
 3. Compile the C# code in a Docker container
@@ -49,6 +54,55 @@ This will:
 
 Consider adding more integration tests for new generators.
 
+## Setting Up Lefthook
+
+To streamline the setup of Git hooks for this project, we utilize [Lefthook](https://github.com/evilmartians/lefthook). Lefthook automates pre-commit and pre-push checks, ensuring consistent enforcement of best practices across the team. These checks include code formatting, documentation generation, and running tests.
+
+This tool is particularly helpful for new contributors or those returning to the project after some time, as it provides a seamless way to align with the project's standards. By catching issues early in your local development environment, Lefthook helps you address potential problems before opening a Pull Request, saving time and effort for both contributors and maintainers.
+
+### Installation
+
+1. Install Lefthook using Homebrew:
+
+   ```bash
+   brew install lefthook
+   ```
+
+2. Install the Lefthook configuration into your Git repository:
+
+   ```bash
+   lefthook install
+   ```
+
+### Pre-Commit Hook
+
+The pre-commit hook is configured to run the following check:
+
+1. **Code Formatting**: Ensures all files are properly formatted using `go fmt`. Any changes made by `go fmt` will be automatically staged.
+
+### Pre-Push Hook
+
+The pre-push hook is configured to run the following checks:
+
+1. **Documentation Generation**: Runs `make generate-docs` to ensure documentation is up-to-date. If any changes are detected, the push will be blocked until the changes are committed.
+2. **Tests**: Executes `make test` to verify that all tests pass. If any tests fail, the push will be blocked.
+
+### Running Hooks Manually
+
+You can manually run the hooks using the following commands:
+
+- Pre-commit hook:
+
+  ```bash
+  lefthook run pre-commit
+  ```
+
+- Pre-push hook:
+
+  ```bash
+  lefthook run pre-push
+  ```
+
 ## Templates
 
 ### Data
diff --git a/Makefile b/Makefile
index 5e87ad0..2b68a76 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,3 @@
-
 .PHONY: test
 test: 
 	@echo "Running tests..."
@@ -18,4 +17,10 @@ generate-docs:
 generate-schema:
 	@echo "Generating schema..."
 	@go run ./schema/generate-schema.go
-	@echo "Schema generated successfully!"
\ No newline at end of file
+	@echo "Schema generated successfully!"
+
+.PHONY: fmt
+fmt:
+	@echo "Running go fmt..."
+	@go fmt ./...
+	@echo "Code formatted successfully!"
\ No newline at end of file
diff --git a/lefthook.yml b/lefthook.yml
new file mode 100644
index 0000000..758bdac
--- /dev/null
+++ b/lefthook.yml
@@ -0,0 +1,21 @@
+# This file configures Lefthook, a Git hooks manager, for the project.
+# For detailed instructions on how to contribute and set up Lefthook,
+# please refer to the relevant section in the contributing documentation (CONTRIBUTING.md).
+pre-commit:
+  commands:
+    go-fmt:
+      run: go fmt ./...
+      stage_fixed: true
+pre-push:
+  commands:
+    generate-docs:
+      run: |
+        make generate-docs
+        if ! git diff --quiet; then
+          echo "Documentation is outdated. Please run 'make generate-docs' and commit the changes."
+          exit 1
+        fi
+      skip: false
+    tests:
+      run: make test
+      skip: false