git-commiter

git-commit-configurator

This program allows you to define and use rules for your git commits. The goal is to have a repository with structured commit but also explain to people who would like to contribute how commits should be written.

Prerequesite

• Golang

Install

cd git-commit-configurator
go install .

Quick Test

# Supposed you are not in a git repository
 mkdir test
 cd test
 git init
 echo 'Bonjour' >> foo
 git add foo
 git cmt

Custom rules

Conventional commit

{
    "Name": "My commit config",
    "Description": "Use this field to add some metadata",
    "Rules": [
        {
            "Prefix": "feat",
            "Description": "feat: Implement new feature"
        },
        {
            "Prefix": "doc",
            "Description": "doc: writing doc"
        },
        {
            "Prefix": "fix",
            "Description": "fix: fix bug"
        },
        {
            "Prefix": "style",
            "Description": "style: change something without modyfing feature"
        },
        {
            "Prefix": "ci",
            "Description": "ci: improve ci"
        }
    ]
}

Modifier style

{
    "Name": "My commit config",
    "Description": "Use this field to add some metadata",
    "Rules": [
        {
            "Prefix": "[ADD]",
            "Description": "[ADD]: Add some code"
        },
        {
            "Prefix": "[UPT]",
            "Description": "[UPT]: Update or improve some code"
        },
        {
            "Prefix": "[FIX]",
            "Description": "[FIX]: fix bug"
        }
    ]
}

Why not emojis ?

{
    "Name": "My commit config",
    "Description": "Use this field to add some metadata",
    "Rules": [
        {
            "Prefix": "✨",
            "Description": "✨: New feature"
        },
        {
            "Prefix": "🐛",
            "Description": "🐛: Fix bug"
        },
        {
            "Prefix": "📚",
            "Description": "📚: Add some documentation"
        }
    ]
}

License

MIT licensed

Copyright (c) 2020 Anas El Halouani