Skip to content

A pre-commit to check if first commit message complies with conventional commits

Notifications You must be signed in to change notification settings

BrightNight-Energy/conventional-commit-check

Repository files navigation

Conventional commit check

A pre-commit hook to check if the first commit complies with conventional commits

To use, create a .pre-commit-config.yaml in your repo and add the following:

repos:
  - repo: https://github.com/BrightNight-Energy/conventional-commit-check
    rev: v1.0.0  # Use the latest tag or commit SHA
    hooks:
      - id: first-commit-check
        stages: [commit-msg]

To install, use:

pre-commit install --install-hooks
pre-commit install --hook-type commit-msg

✨ No configuration file, zero-dependency ✨

Customize commit parser

By default, the angular commit parser is used.

If you'd like to use the emoji commit parser, use the below configuration. More info here.

repos:
  - repo: https://github.com/BrightNight-Energy/conventional-commit-check
    rev: v1.0.0  # Use the latest tag or commit SHA
    hooks:
      - id: first-commit-check
        stages: [commit-msg]
        args: [--parser=emoji]

About

A pre-commit to check if first commit message complies with conventional commits

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages