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

git提交规范

Git提交规范是确保代码历史可读性和团队协作效率的重要实践,以下是核心规范:

一、提交信息格式规范

标准结构

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

Header(必填):包含提交类型(type)、作用域(scope,可选)、简短描述(subject)。
Body(可选):详细说明改动动机、对比旧逻辑,或标记破坏性变更(如BREAKING CHANGE)。
Footer(可选):关联Issue或说明重大变更影响。

提交类型(Type)

类型 用途

	feat	 新增功能fix	     修复Bugdocs	 文档更新style	 代码格式调整(如空格、缩进)refactor 代码重构(不涉及功能变更)perf	 性能优化test	 测试用例修改或新增build	 构建工具或依赖变更(如Webpack配置)chore	 其他杂项(如.gitignore调整)revert	 撤销某次提交

其他要求

字符限制:每行不超过72或100字符,避免自动换行。
时态与语态:使用祈使语气(如"Fix"而非"Fixed")。

二、分支管理规范(补充)

主分支:master/main(生产环境)、develop(开发环境)。
临时分支:feature/xxx(新功能)、fix/xxx(Bug修复)。
命名原则:清晰描述功能或问题(如feat/user-login)。

三、示例

feat(auth): 新增用户登录验证功能 - 实现JWT Token生成与校验 
- 添加用户角色权限控制 BREAKING CHANGE: 废弃旧版Session验证方式 
Closes #123 

通过规范提交,团队可高效生成CHANGELOG、回溯问题,并提升代码审查效率。

相关文章:

  • Linux的应用领域,测试与Linux,Linux的介绍,VirtualBox和Ubuntu的安装,VMware的安装和打开虚拟机CentOS
  • 密码学(二)流密码
  • Delphi HMAC算法
  • Spring常用注解
  • 大模型在轮状病毒肠炎预测及临床方案制定中的应用研究
  • 工厂能耗系统智能化解决方案 —— 安科瑞企业能源管控平台
  • AF3 create_alignment_db_sharded脚本create_shard函数解读
  • mysql删除表后重建表报错Tablespace exists
  • Grafana安装
  • 云服务器X86计算和Arm计算架构有什么区别?
  • 莒县第六实验小学:举行“阅读世界 丰盈自我”淘书会
  • Xilinx 7系列fpga在线升级和跳转
  • AF3 create_alignment_db_sharded脚本process_chunk函数解读
  • 视频设备轨迹回放平台EasyCVR利旧前端设备,打造智慧校园视频上云方案
  • Apifox 全面支持 LLMs.txt:让 AI 更好地理解你的 API 文档
  • python的import类与模块区别
  • windows上rabbitmq服务激活后 15672无法打开
  • 灰度共生矩阵(GLCM)简介
  • ROS2模块库概览
  • 20.3 使用技巧2
  • 做网站用ui好还是ps/竞价托管选择微竞价
  • 武汉大学人民医院招聘/北仑seo排名优化技术
  • 怎么查网站有没有做404/全球搜索引擎排行榜
  • 网站怎么添加代码/视频号的网站链接
  • 南山做网站价格/百度北京分公司官网
  • 2345网站入口/搜索指数