explaining the pre-commit hooks

Author: LevanBokeria

.pre-commit-config.yaml

@@ -6,17 +6,20 @@ repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v5.0.0
   hooks:
-    - id: trailing-whitespace
-    - id: end-of-file-fixer
-    - id: check-yaml
-    - id: check-json
-    - id: check-added-large-files
+    - id: trailing-whitespace # remove trailing whitespace
+    - id: end-of-file-fixer # ensure files end with a newline
+    - id: check-yaml # check YAML files for syntax errors
+    - id: check-json # check JSON files for syntax errors
+    - id: check-added-large-files # check for large files
       args: ['--maxkb=500'] # set the max file size to 500KB
-    - id: check-case-conflict
-    - id: check-merge-conflict
-    - id: check-symlinks
+    - id: check-case-conflict # check for case conflicts in filenames.
+    - id: check-merge-conflict # This hook checks for merge conflict markers in files.
+    # It ensures that there are no unresolved merge conflicts in the codebase.
+    - id: check-symlinks # check for broken symlinks
     # - id: debug-statements
-    - id: mixed-line-ending
+    - id: mixed-line-ending # check for mixed line endings, meaning that
+      # a file contains both CRLF and LF line endings. This can cause issues
+      # when working with files across different operating systems.
 
 # - repo: https://github.com/psf/black
 #   rev: 25.1.0  # Use the latest stable version