当前位置: 首页 > news >正文

Git 使用规范:起名字、提交描述的最佳实践

1. 推荐写法(本人常用)

Git 仓库命令规则

  • 前端:系统名-简单描述-front
  • 后端:系统名-简单描述-server

Git 提交描述

docs(changelog): update change log to beta.5其中:
● docs 则对应修改的类型
● changelog 则是影响的范围
● subject 则是对应做的事件

对应的类型有

  • build:影响构建系统或外部依赖关系的更改(示例范围:gulp,broccoli,npm)
  • ci:更改我们的持续集成文件和脚本(示例范围:Travis,Circle,BrowserStack,SauceLabs)
  • docs:仅文档更改
  • feat:一个新功能
  • fix:修复错误
  • perf:改进性能的代码更改
  • refactor:代码更改,既不修复错误也不添加功能
  • style:不影响代码含义的变化(空白,格式化,缺少分号等)
  • test:添加缺失测试或更正现有测试

2. 工作写法

Git 提交描述

一般公司会使用一些第三方工具,例如:Jira、Ones等,通过这些看板工具来管理团队的任务。每一个任务都会有对应的任务号。

因此,这个时候提交就会规范一点:

# 类似格式 如下:
[任务卡号] xx & xx: do something # 举个例子,Ones格式如下:
#79612 描述内容
http://ones.xxx.com/project/#/team/HvBrmPic/task/GSCnZc5zd2dDgl8F

3. 常规写法

[任务分类] 主要修改组件(可选):修改内容

示例 1,[T] tabs: add icons 。其中的 T 表示这是一个技术卡,tabs 表示修改的是 Tabs,add icons 则表示添加了图标。

示例 2,[SkillTree] detail: add link data。其中的 SkillTree 表示修改的是技能树 Tab 下的内容,detail 则表示修改的是详情页,add link data 则表示是添加了技能的数据

优点:轻松 filter 出相应业务的内容

缺点:要这样做需要团队达到一致,因此付出一些额外的成本。

💡以上参考:GitHub 漫游指南

相关文章:

  • Linux(ubuntu)下git / github/gitee使用
  • Java:表单生成excel文档 poi 通用
  • 001、安装 Rust
  • 【软件测试】为bug而生
  • HarmonyOS page生命周期函数讲解
  • 水准网、平面导线平差
  • 双击编辑el-table的单元格数据
  • 【ADB】电脑通过ADB向手机传输文件
  • Python 实现 PDF 到 Word 文档的高效转换(DOC、DOCX)
  • GET和POST请求
  • Linux驱动开发学习笔记6《蜂鸣器实验》
  • 智能优化算法应用:基于减法平均算法3D无线传感器网络(WSN)覆盖优化 - 附代码
  • 边缘计算网关:重新定义物联网数据处理
  • WPS中如何根据身份证号生成出生日期并排序
  • android studio官方网站关于android SDK环境变量的设置说明晦涩难懂
  • 「前端」从UglifyJSPlugin强制开启css压缩探究webpack插件运行机制
  • 【Leetcode】104. 二叉树的最大深度
  • 【跃迁之路】【519天】程序员高效学习方法论探索系列(实验阶段276-2018.07.09)...
  • C++类中的特殊成员函数
  • If…else
  • leetcode98. Validate Binary Search Tree
  • Logstash 参考指南(目录)
  • Node项目之评分系统(二)- 数据库设计
  • Python十分钟制作属于你自己的个性logo
  • React 快速上手 - 07 前端路由 react-router
  • React的组件模式
  • RedisSerializer之JdkSerializationRedisSerializer分析
  • Spark VS Hadoop:两大大数据分析系统深度解读
  • Spring Cloud Alibaba迁移指南(一):一行代码从 Hystrix 迁移到 Sentinel
  • Travix是如何部署应用程序到Kubernetes上的
  • Vue.js 移动端适配之 vw 解决方案
  • vue和cordova项目整合打包,并实现vue调用android的相机的demo
  • 测试如何在敏捷团队中工作?
  • 从零搭建Koa2 Server
  • 仿天猫超市收藏抛物线动画工具库
  • 关于字符编码你应该知道的事情
  • 官方新出的 Kotlin 扩展库 KTX,到底帮你干了什么?
  • 王永庆:技术创新改变教育未来
  • 长三角G60科创走廊智能驾驶产业联盟揭牌成立,近80家企业助力智能驾驶行业发展 ...
  • ​ArcGIS Pro 如何批量删除字段
  • ​第20课 在Android Native开发中加入新的C++类
  • #Ubuntu(修改root信息)
  • (3)(3.5) 遥测无线电区域条例
  • (6)【Python/机器学习/深度学习】Machine-Learning模型与算法应用—使用Adaboost建模及工作环境下的数据分析整理
  • (ibm)Java 语言的 XPath API
  • (ZT) 理解系统底层的概念是多么重要(by趋势科技邹飞)
  • (附源码)计算机毕业设计SSM智能化管理的仓库管理
  • (四)Tiki-taka算法(TTA)求解无人机三维路径规划研究(MATLAB)
  • (五)c52学习之旅-静态数码管
  • (原+转)Ubuntu16.04软件中心闪退及wifi消失
  • (转)JVM内存分配 -Xms128m -Xmx512m -XX:PermSize=128m -XX:MaxPermSize=512m
  • (转)程序员疫苗:代码注入
  • (转)原始图像数据和PDF中的图像数据
  • .【机器学习】隐马尔可夫模型(Hidden Markov Model,HMM)
  • .naturalWidth 和naturalHeight属性,