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

Git提交信息

Git 提交信息规范 (Conventional Commits)

一个好的 Git 提交信息能清晰记录项目的演变,方便团队协作和问题追溯。


基本结构

一个完整的提交信息包含三个部分:Header (头部)、Body (正文) 和 Footer (页脚)。

<type>(<scope>): <subject><body><footer>
  • Header (必需): 简明扼要地描述改动类型和内容。
    • type (类型): 强制性,说明提交的性质。
      • feat: 新增功能。
      • fix: 修复 Bug。
      • docs: 修改文档。
      • style: 格式调整,不影响代码运行。
      • refactor: 重构代码。
      • test: 新增或修改测试。
      • chore: 构建或辅助工具的变动。
    • scope (范围): 可选,说明改动影响的模块。
    • subject (主题): 简短描述,使用祈使句,首字母小写,结尾无句号。
  • Body (可选): 提供更详细的改动背景和原因。
  • Footer (可选): 用于说明不兼容的变更,或关联相关的 Issue。

实践案例

不规范的提交信息

fixed bug
  • 问题:没有上下文,不知道修复了什么。

规范的提交信息

fix(auth): fix login button not redirecting to dashboardThe login button was not correctly redirecting authenticated users. This commit fixes the logic to ensure the redirect happens after a successful login.Closes #123
  • 优点
    • fix: 明确是 Bug 修复。
    • (auth): 表明影响认证模块。
    • 主体:描述了具体问题。
    • 正文:解释了为什么修复以及如何修复。
    • Closes #123: 关联了对应的 Issue。
http://www.dtcms.com/a/358869.html

相关文章:

  • 不用公网IP也能?cpolar实现Web-Check远程安全检测(1)
  • Qt 窗口 - 3
  • 弱内存模型和强内存模型架构(Weak/Strong Memory Model)
  • stack queue的实现 deque的底层结构 priority_queue的实现
  • easy-http类似feign的轻量级http客户端工具
  • C++三方服务异步拉起
  • 针对 “TCP 连接中断 / 终止阶段” 的攻击
  • K8s卷机制:数据持久化与共享
  • 当“循环经济”遇上“小程序”,旧物回收正迎来“智慧”升级
  • 奥普新汽车声学测试方案书
  • 谷歌 “Nano Banana“ 深度解析:AI 图像的未来是精准编辑,而非从零生成
  • 构建现代化的“历史上的今天“网站:从API到精美UI的全栈实践
  • jumpserver
  • 字数统计器和文本AI处理,非常好用
  • 【Leetcode】17、电话号码的字母组合
  • MYSQL速通(3/5)
  • Agno - 轻量级Python多智能体系统框架
  • Python可视化与交互-matplotlib库
  • 后台技术方案设计经验之谈
  • C读写xlsx库xlsxio的编译和测试
  • 第2.3节:AI大模型之Claude系列(Anthropic)
  • k8s 定时任务需求模板
  • 直流无刷电机2
  • 【计算机408计算机网络】第四章:自底向上五层模型之网络层
  • Linux IO复用
  • DeepConf:基于置信度提高LLM表现
  • Tomcat 企业级运维实战系列(五):Tomcat 优化和安全加固
  • Tiptrans转运 | 免费5国转运地址
  • Java中不太常见的语法-总结
  • static静态文件和requests请求对象