guandata-commit-format

A tool to unify the commit format in your tech teams.

The result format of the commits looks like : TaskId CommitType: Subject

T123 fix: Fix scrolling problem on android device

or just

CommitTypes: Subject

feat: Implement the pipeline between hive and spark engine

After proper setup, this tool will prompt questions for you to answer, and thus guide you to build the commit string in either types of the above two.

Setup:

First off, you need install commitizen, both globally (for easy use of git-cz command) and project-wise

npm install commitizen -g

npm install commitizen --save-dev

and then

npm install guandata-commit-format --save-dev

and then let commitizen points to this tool,

commitizen init guandata-commit-format --save-dev --save-exact

After all the above is done, you can use git cz to use this tool to help with your commit message. Meantime, you can still use git commit as usual.

Credit:

• For the 1st case, if you are happening on a git branch whose name includes the taskId (say, T3311-filter-design), you can just hit enter and let this tool to pick the task id for you.

• Based on the good work of commitizen and conventional changelog.