Merge pull request nerc-project#210 from sudoCommit/feature/nerc-project#209

nerc-project#209: add pre-commit hooks

Author: QuanMPhm

.github/workflows/pre-commit.yaml

@@ -0,0 +1,22 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Run pre-commit hooks
+        uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: detect-private-key
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

README.md

@@ -153,3 +153,17 @@ following resource allocation attribute types.
 
 By submitting a Resource Allocation Change Request and editing those attributes
 a PI can request a change in their quota.
+
+## Pre-commit hooks
+```
+pip install pre-commit
+```
+Pre-commit runs tools like:
+- [Ruff](https://docs.astral.sh/ruff/) — fast linter and fixer
+- Basic checks like trailing whitespace removal, JSON validation, and more.
+
+To set up Git hook locally:
+```
+pre-commit install
+```
+After this, every time you make a commit, the hooks will run automatically!