功能介绍

git hook 实现用户提交 git commit -m "#f 功能A开发" 自动转变为 git commit -m "KJDS-xxxxx feature: 功能A开发"

规范git commit message的格式，达到以下两点要求：

1. commit与jira自动对应，即需求与代码一致性
2. 强制commit type只允许为七种类型，进一步规范commit message

另外，还提供了git push邮件通知的功能，方便code reviewer监督，该功能需主动配置开启

使用方法

git hook依赖于husky模块，工程内如果已经引过husky并利用（或不需要）lint-staged做commit前的eslint校验，则可以跳过lint-stage部分（但是需要升级husky至^1.3.1，升级lint-staged至^8.1.0，并根据husky升级版本更新package.json配置方式）

1. 工程内安装husky以及初始化其他依赖

npm install husky --save-dev
npm install lint-staged --save-dev
npm install prepare-commit --save-dev

2. 工程内配置根路径package.json中的husky钩子

    ...
    "husky": {
        "hooks": {
            //...
            "pre-commit": "lint-staged",
            "prepare-commit-msg": "prepareCommit"
        }
    },
    //以下请根据工程自行定义
    "lint-staged": {
        "**/*.{js,vue}": [
            "eslint -c .eslintrc.js --fix",
            "git add"
        ],
        "./eslintrc.js": [
            "eslint -c .eslintrc.js --fix",
            "git add"
        ]
        //...
    }
    ...

3. 【忽略】git push邮件通知功能开启【邮件功能转移到ci中完成】

项目根目录下（git目录）新建.preparecommitrc, 配置邮箱功能开启，并配置收件人列表

{
    "emailEnable": true,
    "emailGroup": [
        "[email protected]"
    ]
}

【附录】git commit message 简化规范

** Commit message 包括三个部分：jira【必需】，type【必需】，message【必需】, scope【可选】

jira(工具自动带出)【必需】

jira号用于将代码与需求保持一致性

写一段代码通常意味着实现一个需求或修复一个缺陷，将代码与需求或缺陷关联对软件生命周期最长的维护阶段来说是一件非常有意义的事

commit message的jira号由工具自动带出

type(#首字母，工具自动补全)【必需】

type用来说明commit的类别，只允许以下7个标识, 其中feature和fix出现在changelog

1. #f：新功能（#feature）
2. #b：修补bug（#fix）
3. #d：文档（#documentation）
4. #s： 格式（不影响代码运行的变动）(#style)
5. #r：重构（即不是新增功能，也不是修改bug的代码变动）（#refactor）
6. #t：增加测试（#test）
7. #c：构建过程或辅助工具的变动(#chore)

message【必需】

message用于说明 commit 的描述

1. 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
2. 第一个字母小写
3. 结尾不加句号（.）

scope【可选】

有必要的话可以说明此次提交的影响面

参考

参考链接【代码与需求保持一致】

参考链接【git message规范】