Skip to content

feat: Add hooks to project (pre-commit / Lefthook / etc) #43

@kzndotsh

Description

@kzndotsh

🚀 Feature Request

It would be beneficial to add automated git hooks to this project. This would help enforce code quality, formatting, linting, and other checks before changes are committed or pushed.

Recommended Tools:

Potential Steps:

  1. Decide between pre-commit, Lefthook, or another tool.
  2. Configure common hooks:
    • Lint checks
    • Code formatting (e.g., ruff, markdownlint, etc)
    • Type checking (if applicable, e.g., pyright/mypy)
    • Test runner (optional)
  3. Add setup instructions to the README.
  4. Ensure hooks are easy to install (document or automate).

Benefits:

  • Improved code quality and consistency.
  • Reduced review overhead.
  • Early detection of issues.

Tasks:

  • Research and select a hook management tool
  • Configure basic hooks
  • Update documentation
  • Add installation/setup instructions

Reference:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions