angular代码规范_Gitcommitmessage规范
git是现在市⾯上最流⾏的版本控制⼯具，书写良好的commit message能⼤⼤提⾼代码维护的效率。但是在⽇常开发中由于缺少对于commit message的约束，导致填写内容随意、质量参差不齐，可读性低亦难以维护。在项⽬中引⼊commit message规范已是迫在眉睫。
⽤什么规范？
现在市⾯上⽐较流⾏的⽅案是约定式提交规范（Conventional Commits），它受到了Angular提交准则的启发，并在很⼤程度上以其为依据。约定式提交规范是⼀种基于提交消息的轻量级约定。 它提供了⼀组⽤于创建清晰的提交历史的简单规则；这使得编写基于规范的⾃动化⼯具变得更容易。这个约定与SemVer相吻合，在提交信息中描述新特性、bug 修复和破坏性变更。它的 message 格式如下:
<；类型>[可选的作⽤域]: <；描述>
[可选的正⽂]
[可选的脚注]
Quick Start
1. 全局安装commitizen & cz-conventional-changelog
commitizen是⼀个撰写合格commit message的⼯具，⽤于代替git commit 指令，⽽cz-conventional-changelog适配器提供conventional-changelog标准（约定式提交标准）。基于不同需求，也可以使⽤不同适配器。
npm install -g commitizen cz-conventional-changelog
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
安装完毕后，可直接使⽤git cz来取代git commit。
全局模式下，需要 ~/.czrc 配置⽂件, 为commitizen指定Adapter。
2. 项⽬内安装commitlint & husky
commitlint负责⽤于对commit message进⾏格式校验，husky负责提供更易⽤的git hook。
Use npm
npm i -D husky @commitlint/config-conventional @commitlint/cli
Use yarn
yarn add husky @commitlint/config-conventional @commitlint/cli -D
commitlint只能做格式规范，⽆法触及内容。对于内容质量的把控只能靠我们⾃⼰。
angular安装3. 添加相应配置
创建fig.js
# In the same path as package.json
echo 'ports = {extends: ["@commitlint/config-conventional"]};' > ./fig.js
引⼊husky
# package.json
...,
"husky": {
"hooks": {
"commit-msg": "commitlint -e $GIT_PARAMS"
}
}
4. 使⽤
执⾏git cz进⼊interactive模式，根据提⽰依次填写
1.Select the type of change that you're committing 选择改动类型 (<type>)
2.What is the scope of this change (e.g. component or file name)? 填写改动范围 (<scope>)
3.Write a short, imperative tense description of the change: 写⼀个精简的描述 (<subject>)
4.Provide a longer description of the change: (press enter to skip) 对于改动写⼀段长描述 (<body>)
5.Are there any breaking changes? (y/n) 是破坏性修改吗？默认n (<footer>)
6.Does this change affect any openreve issues? (y/n) 改动修复了哪个问题？默认n (<footer>)
⽣成的commit message格式如下：
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
填写完毕后，husky会调⽤commitlint对message进⾏格式校验，默认规定type及subject为必填项。
任何git commit指令的option都能⽤在 git cz指令上, 例如git cz -a
Commit message规范在rrd-fe落地使⽤情况
针对团队⽬前使⽤的情况，我们讨论后拟定了commit message每⼀部分的填写规则。
1. type
type为必填项，⽤于指定commit的类型，约定了feat、fix两个主要type，以及docs、style、build、refactor、revert五个特殊type，其余type暂不使⽤。
# 主要type
feat:    增加新功能
fix:      修复bug
# 特殊type
docs:    只改动了⽂档相关的内容
style:    不影响代码含义的改动，例如去掉空格、改变缩进、增删分号
build:    构造⼯具的或者外部依赖的改动，例如webpack，npm
refactor: 代码重构时使⽤
revert:  执⾏git revert打印的message
# 暂不使⽤type
test:    添加测试或者修改现有测试
perf:    提⾼性能的改动
ci:      与CI（持续集成服务）有关的改动
chore:    不修改src或者test的其余修改，例如构建过程或辅助⼯具的变动
当⼀次改动包括主要type与特殊type时，统⼀采⽤主要type。
2. scope
scope也为必填项，⽤于描述改动的范围，格式为项⽬名/模块名，例如： node-pc/common rrd-h5/activity，⽽we-sdk不需指定模块名。如果⼀次commit修改多个模块，建议拆分成多次commit，以便更好追踪和维护。
3. body
body填写详细描述，主要描述改动之前的情况及修改动机，对于⼩的修改不作要求，但是重⼤需求、更新等必须添加body来作说明。
4. break changes
break changes指明是否产⽣了破坏性修改，涉及break changes的改动必须指明该项，类似版本升级、接⼝参数减少、接⼝删除、迁移等。
5. affect issues
填写⽅式例如：
re #JIRA_ID
fix #JIRA_ID
⽰例
完整的commit message⽰例
相应的git log
扩展阅读
conventional commits 必读 介绍约定式提交标准。
Angular规范 必读 介绍Angular标准每个部分该写什么、该怎么写。
@commitlint/config-conventional 必读 介绍commitlint的校验规则config-conventional，以及⼀些常见passes/fails情况。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。