python 编程规范代号_前端编码规范之:Git使用规范

前端编码规范之:Git使用规范

前端编码规范之:样式(scss)编码规范

前端编码规范之:HTML结构规范

前端编码规范之:Vue最佳实践

前端编码规范之:Javascript编码规范

整理了下,基本的git操作可以自己新建一个github的repo熟悉下。

Git版本规范

分支

master分支为主分支(保护分支),不能直接在master上进行修改代码和提交

develop分支为测试分支,所以开发完成需要提交测试的功能合并到该分支

feature分支为开发分支,大家根据不同需求创建独立的功能分支,开发完成后合并到develop分支,merge完成就可以删除

fix分支为bug修复分支,需要根据实际情况对已发布的版本进行漏洞修复,merge完成就可以删除

Tag

采用三段式,v版本.里程碑.序号,如v1.2.1

架构升级或架构重大调整,修改第2位

新功能上线或者模块大的调整,修改第2位

bug修复上线,修改第3位

changelog

版本正式发布后,需要生产changelog文档,便于后续问题追溯

commit message规范

Commit message一般包括三部分:Header、Body和Footer

Header

type(scope):subject。

type:用于说明commit的类别,规定为如下几种

feat:新增功能;

fix:修复bug;

docs:修改文档;

refactor:代码重构,未新增任何功能和修复任何bug;

build:改变构建流程,新增依赖库、工具等(例如webpack修改);

style:仅仅修改了空格、缩进等,不改变代码逻辑;

perf:改善性能和体现的修改;

chore:非src和test的修改;

test:测试用例的修改;

ci:自动化流程配置修改;

revert:回滚到上一个版本;

scope:【可选】用于说明commit的影响范围

subject:commit的简要说明,尽量简短

Body

对本次commit的详细描述,可分多行

尾部(Footer)

不兼容变动:需要描述相关信息

关闭指定Issue:输入Issue信息

Git Commit 优点

统一团队Git Commit标准,便于后续代码review、版本发布、自动化生成change log

可以提供更多更有效的历史信息,方便快速预览以及配合cherry-pick快速合并代码

团队其他成员进行git blame等操作可以快速明白代码用意

git commit emoji 使用指南

============================

你可能感兴趣的:(python,编程规范代号)