README.md

honey-git-flow

A new git flow with hooks for waffle.io. And now you have a Waffle with honey.

Configure

Init

You need create in your root folder a gitValidations.json

{
    "branchMasters": [
        "master",
        "develop"
    ],
    "branchNames": [
        "feature/#ID_ISSUE/shortest_description",
        "fix/#ID_ISSUE/shortest_description"
    ],
    "commit": {
        "pattern": "<type>(<scope>): <subject>",
        "rules": [
            {
                "type": "regex",
                "rule": "feature|fix|refactor|test|chore",
                "message": "Missing commit (feature, fix, refactor, test or chore)."
            },
            {
                "rule": ":",
                "message": "Missing colon (:)"
            }
        ]
    }
}

BranchMasters: It's a property reference for name of your branchs without pattern. BranchNames: It's a property reference for name of your branchs with pattern. Commit: It's a template of your commit pattern.

(remembering that it is necessary everywhere the ids of the issue)

Pre-commmit

Add in scripts of your package.json

"commitmsg": "node node_modules/honey-git-flow/gitValidations.js commit"

Rebase Blocker (Its a extra)

"prerebase": "node node_modules/honey-git-flow/gitValidations.js rebase"

*** We have a issue #3 to create a CLI to trigger this in another way ***

Usage

Example of commit message

git commit -m "feature(new-table) | we develop a new table"

Ps.: This example apply Karma Pattern.

Example of branch name

feature/#000/test-feature
fix/#000/test-feature
test/#000/test-feature

Example of PR name

closes #000 | test message

Ps.: We can use Github's helper as prefix in yours PR's

Common problems

If your ghooks not triggered, you need to delete .git/hooks. And re-install the ghooks of husky using $ node node_modules/husky/bin/install.js