生活不能随意过,代码也不能随意写。
前一篇文章我们已经把项目搭建好了,那是不是马上就开始写页面了呀?
NO!
无论在哪家公司,都会有相应的代码规范。新入职的员工往往第一步就要接受代码规范的学习。
既然是实战项目,我们也得在写页面之前把相关的规范配置做好。
今天我们先来看看项目中git的使用及相关规范吧。
Git规范及项目配置
目的
- 统一团队Git Commit标准,便于后续代码review、版本发布、自动化生成change log;
- 可以提供更多更有效的历史信息,方便快速预览以及配合cherry-pick快速合并代码;
- 团队其他成员进行类
git blame
时可以快速明白代码用意;
版本规范
1.分支
- master: 主分支(保护分支),不能直接在master上进行修改代码和提交;
- develop: 测试分支,所以开发完成需要提交测试的功能合并到该分支;
- feature-*: 新功能开发分支,根据不同需求创建独立的功能分支,开发完成后合并到develop分支;
- hotfix-*: bug修复分支,根据实际情况对已发布的版本进行漏洞修复;
- release-*: 预发布分支。
2.Tag
采用三段式,v版本.里程碑.序号,如v1.2.3
- 架构升级或架构重大调整,修改第1位
- 新功能上线或者模块大的调整,修改第2位
- bug修复上线,修改第3位
3.changelog
版本正式发布后,需要生产changelog文档,便于后续问题追溯。
提交规范
Git commit日志基本规范
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
1<type>(<scope>): <subject>
2// 空一行
3<body>
4// 空一行
5<footer>
注意冒号后面有空格。
其中,Header 是必需的,Body 和 Footer 可以省略。
Header:
Header部分只有一行,包括三个字段:type
(必需)、<