From 97eb8e27673a3a54849ae8a3702f9bb070cd645f Mon Sep 17 00:00:00 2001
From: ahuston-0 <aliceghuston@gmail.com>
Date: Mon, 20 May 2024 01:06:40 -0400
Subject: [PATCH] adds comments for pre-commit checks

Signed-off-by: ahuston-0 <aliceghuston@gmail.com>
---
 checks.nix | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/checks.nix b/checks.nix
index 397d9ab..3512f4a 100644
--- a/checks.nix
+++ b/checks.nix
@@ -9,7 +9,7 @@ forEachSystem (system: {
     src = ./.;
     hooks = {
       # nix checks
-      # Example custom hook for nix formatting:
+      # Example custom hook for nix formatting
       fmt-check = {
         enable = true;
 
@@ -20,6 +20,7 @@ forEachSystem (system: {
         # see also https://pre-commit.com/#hooks-files
         files = "\\.nix$";
       };
+      ## static analysis checks for nix
       nil.enable = true;
       statix.enable = false;
 
@@ -32,10 +33,12 @@ forEachSystem (system: {
 
       # git hooks
       check-merge-conflicts.enable = true;
+      ## prevents committing to main
       no-commit-to-branch.enable = true;
 
       # misc hooks
       check-added-large-files.enable = true;
+      ## prevents two similarly named files for case sensitive systems
       check-case-conflicts.enable = true;
       detect-private-keys.enable = true;
     };