micro/.githooks/README.md

520 B

Git Hooks

This repository standard uses a project-local hooks directory:

  • .githooks/pre-commit

Activate it once per repository:

git config core.hooksPath .githooks

The pre-commit hook validates for staged .sh files:

  • executable bit in Git index (100755)
  • LF line endings (no CRLF)

The pre-commit hook also validates staged .md files with markdownlint:

  • no markdownlint errors or problems
  • requires markdownlint CLI in PATH (for example via npm install --global markdownlint-cli)