基于tapd的git commit规范
现状
开发团队中,总是有人提交代码时的commit内容乱写一通,或者不明确不完整。当回溯代码的时候,很难通过commit内容定位历史记录,只能一条一条查看,找不到就要去问历史参与开发的其他同事,沟通成本太高了。定义commit规范,能够一定程度解决这个问题,规范一定要简单,过于严苛和复杂会让提交者厌烦。如果您的团队采用tapd作为敏捷开发平台,可以参考这套规范。
规范
示例:
TAPD需求标题:类型:主题
解释:
- 内容由3个部分构成:TAPD需求标题、类型标识和主题,中间用全角或者半角逗号分隔。
- 如果tapd标题很长,可以截取前10到15位,tapd标题必须填写。
类型列表:
类型 | 缩写 | 解释 | 必填 |
---|---|---|---|
feature | fea | 新功能开发 | 否 |
fixbug | fix | 修复BUG | 是 |
test | test | 测试用例 | 是 |
refactor | ref | 重构,即不是新功能也不是修改bug | 是 |
build | build | 影响构建或外部依赖项 | 是 |
style | style | 修改了代码格式 | 是 |
doc | doc | 修改了文档 | 是 |
other | oth | 其他的修改 | 是 |
示例1:新功能开发
开发需求“订单满1000元送优惠券”,commit范例如下:
订单满1000元送优惠券:fea:判断订单金额
或者 订单满1000元送优惠券:判断订单金额
由于新功能开发是常态,fea可以省略不写。如果发现某个地方有优化的空间,但是与本次需求无关,commit范例如下:
订单满1000元送优惠券:ref:优化了订单查询性能
示例2:解决BUG
需求“订单满1000元送优惠券“已上线,后来发现bug,commit范例如下:
订单满1000元送优惠券:fix:修复重复赠送优惠券的问题
其他几种类型,就不一一列举示例了,这个规范的特点是:通过commit历史找到对应的tapd,通过tapd的内容回溯业务逻辑。
基于tapd的git commit规范的更多相关文章
- git & Angular git commit 规范
git & Angular git commit 规范 https://github.com/angular/angular/commits/master https://github.com ...
- git commit规范工具
npm install -g commitizen commitizen init cz-conventional-changelog --save --save-exact 以后,凡是用到git c ...
- git commit 规范
- 如何规范git commit提交
相信很多人使用SVN.Git等版本控制工具时候都会觉得每次提交都要写一个注释有什么用啊?好麻烦,所以我每次都是随便写个数字就提交了,但是慢慢的我就发现了,如果项目长期维护或者修改很久之前的项目,没有一 ...
- git 提交规范
git 提交规范 前言 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项 ...
- 你可能会忽略的 Git 提交规范
一.为什么需要规范? 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项目 ...
- 规范git commit提交记录和版本发布记录
在开发过程中我们一般都会用到git管理代码,在git commit提交代码时我们一般对git commit message随便写点简单的描述,可是随着项目参与人数的增多,发现提交的commit记录越来 ...
- Git commit message和工作流规范
目的 统一团队Git commit日志标准,便于后续代码review,版本发布以及日志自动化生成等等. 统一团队的Git工作流,包括分支使用.tag规范.issue等 Git commit日志参考案例 ...
- git commit的规范
https://www.yuque.com/fe9/basic/nruxq8#6c228def 制定一个 git commit 信息的提交规范是开发团队工作流必不可少的环节.试想一下,如果查看主分支上 ...
- git的commit规范及强制校验
1.背景 在多人协作项目中,如果代码风格统一.代码提交信息的说明准确,那么在后期协作以及Bug处理时会更加方便. 先来介绍本人公司采用的commit规范 Commit message格式 < ...
随机推荐
- mySQL清除数据表数据/删除表
一.sql清空表数据的三种方式: 1.truncate – 删除所有数据,保留表结构,不能撤销还原,速度快 2.delete – 是逐行删除,不适合大量数据删除,速度极慢 3.drop – 删除表,表 ...
- Netty笔记(1) - Netty概述 和 框架结构
概述 基于NIO 的框架,目的是简化开发NIO的工作量 异步的 ,基于事件驱动的网络应用程序框架,用以快速开发高性能.高可靠性的网络 IO 程序 Netty 是目前最流行的 NIO 框架,Netty ...
- Zabbix自动发现:python-json模块应用介绍
一.JSON模块介绍 json模块是python内置的库,其主要功能是将序列化数据从文件里读取出来或者存入文件.该模块有四个方法:dump().load().dumps().loads(),其中dum ...
- Vue 动态插入组件 用js函数的方式
Vue 动态插入组件 用js函数的方式 第一步 import vue组件 第二步 Vue把组件扩展进去 第三步 创建实例 第四步 将组件的el挂载到document.body上 第五步 设置组件内部d ...
- SQL语句之索引操作
目录 索引 创建索引 CREATE INDEX 语句 CREATE UNIQUE INDEX 语句 索引多个列 删除索引 参考资料 索引 可以在表中创建索引,以便更加快速高效地查询数据. 用户无法看到 ...
- 【python】使用百度api进行音频文件转写
[python]使用百度api进行音频文件转写 脚本目标: 智能云的音频文件转写文档只给了个demo,每次只能传1分钟以内的音频啥的,不好直接用,简单打包一下,做到把音频放文件夹,直接出转写结果就行了 ...
- tomcat报错Exception loading sessions from persistent storage解决方案
现象:项目在重启时报错:严重: Exception loading sessions from persistent storage的问题.该问题的原因是tomcat的session持久化机制引起的, ...
- buntu中查看网卡信息的基础知识
ubuntunetworkexpress工具网络access Ubuntu 中,通常有线网卡为eth0,无线网卡则为wlan0,后续增加的以此类推(可能某些无线网卡型号命名为eth1,而非wlan0) ...
- 毕设系列之JrtpLib H264(裸视频数据) 实时视频传输(发送与接受)
PS:要转载请注明出处,本人版权所有. PS: 这个只是基于<我自己>的理解, 如果和你的原则及想法相冲突,请谅解,勿喷. 前置说明 本文作为本人csdn blog的主站的备份.(Bl ...
- PAT 甲级【1009 Product of Polynomials】
/* 系数为0不输出 貌似runtime异常也显示答案不正确*/ import java.io.BufferedReader; import java.io.IOException; import j ...