Skip to content
A global Git hook for adhering to the Conventional Commit specification
Shell Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Makefile
README.md
sailr.json
sailr.sh

README.md

Sailr

Sailr helps you follow the Conventional Commits conventional by installing a configurable commit-msg into your Git projects.

Table of Contents

Prerequisites

To use Sailr you must have jq installed.

Installing

Here is how you can install Sailr.

git clone https://github.com/craicoverflow/sailr
cd sailr
make install

Uninstalling

It's as simple as this:

make uninstall

Usage

Once installed, you must run git init in your Git projects to (re)initialize your repository. Copy the following template into the root of your project, otherwise the hook will be ignored.

{
    "enabled": true,
    "revert": true,
    "length": {
        "min": 1,
        "max": 52
    },
    "types": [
        "build",
        "ci",
        "docs",
        "feat",
        "fix",
        "perf",
        "refactor",
        "style",
        "test",
        "chore"
    ]
}

Note: you can disable Sailr in your project by setting enabled to false in sailr.json_

You can’t perform that action at this time.