Merge pull request #131 from veridatum-labs/chore/pre-commit-guardrails

Add lightweight pre-commit guardrails

Author: Hallab7

.gitattributes

@@ -2,3 +2,5 @@
 # mutation self-test (scripts/mutation-test.ps1 -SelfTest) can apply them with
 # `git apply` regardless of the checkout's autocrlf setting.
 tests/mutation/seeds/*.patch -text
+
+.githooks/* text eol=lf

.githooks/commit-msg

@@ -0,0 +1,28 @@
+#!/bin/sh
+set -eu
+
+message_file="$1"
+subject="$(sed -n '1p' "$message_file" | tr -d '\r')"
+
+case "$subject" in
+  Merge\ *|Revert\ \"*|fixup!\ *|squash!\ *)
+    exit 0
+    ;;
+esac
+
+pattern='^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\([[:alnum:]./_-]+\))?!?: .+'
+
+if printf '%s\n' "$subject" | grep -Eq "$pattern"; then
+  exit 0
+fi
+
+cat <<'EOF'
+Commit message must use a conventional subject, for example:
+  feat: add proof search
+  fix(registry): reject inactive issuers
+  chore!: update supported Rust version
+
+Allowed types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert.
+Scopes, breaking-change markers, issue IDs, and subject punctuation are optional.
+EOF
+exit 1

.githooks/pre-commit

@@ -0,0 +1,16 @@
+#!/bin/sh
+set -eu
+
+staged_files="$(git diff --cached --name-only --diff-filter=ACMRD)"
+
+if [ -z "$staged_files" ]; then
+  exit 0
+fi
+
+if ! printf '%s\n' "$staged_files" | grep -Eq '(Cargo\.lock|Cargo\.toml|\.rs)$'; then
+  echo "pre-commit: no Rust code or Cargo configuration changes; skipping tests."
+  exit 0
+fi
+
+echo "pre-commit: running contracts workspace tests..."
+cargo test --workspace

CONTRIBUTING.md

@@ -7,8 +7,15 @@ This repository contains Soroban contracts for EarnProof issuer status, proof co
 ```bash
 cargo build --workspace
 cargo test --workspace
+git config core.hooksPath .githooks
 ```
 
+Run the Git command once per checkout to enable the tracked hooks. The
+pre-commit hook runs workspace tests when staged Rust or Cargo files change.
+The commit-message hook accepts conventional subjects such as `feat: add proof
+search` and `fix(registry): reject inactive issuers`; scopes and issue IDs are
+optional.
+
 ## Validation
 
 Run these before opening a pull request:
@@ -36,4 +43,3 @@ cargo build --workspace
 - Contract storage, authorization, and event behavior are covered by tests.
 - Documentation matches actual on-chain behavior.
 - Testnet deployment evidence is updated when deployment behavior changes.
-