Getty/IO Commit Message Validator.
This package provides you a binary that you can use as a git hook to validate the commit message using the Getty/IO commit standard.
The Getty/IO commit standard should have a the following format:
git commit -m <scope>: <subtask or title>, task: <url>, spent: <time spent e.g. 2h or 2h30m>
Commit Requirements
scope: can be one of ['chore', 'docs', 'feat', 'fix', 'refactor', 'style', 'test']
task: trello task url
spent: time spent on the task or subtask with the format 1h or 1h30m.
E.g.
git commit -m "feat: add commit validation, task: https://trello.com/c/hfVM9KNV/add-validation-rules, spent: 2h"
Installation
This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:
1. Install husky
npm install husky@beta --save-dev
2. Install this package as one of your project's devDependencies
npm install @getty.io/taskapp --save-dev
or
yarn add @getty.io/taskapp --dev
3. Add husky hook in package.json
{
"husky": {
"hooks": {
"commit-msg": "taskapp"
}
}
}