git的约定式提交

Git 的约定式提交(Conventional Commits)是一种规范化的提交消息格式,用于提供更清晰、更易读的版本控制历史记录。它定义了一套标准的提交消息格式,使得团队成员可以更容易地理解和跟踪代码变更。

约定式提交的格式如下:

复制代码
<类型>(可选的作用域): <描述>

[可选的正文]

[可选的脚注]

其中,各个部分的含义如下:

  • <类型>:表示本次提交的类型,常见的类型包括:

    • feat:新功能(feature)
    • fix:修复Bug
    • docs:文档相关的修改
    • style:代码格式、样式调整
    • refactor:重构代码
    • test:添加或修改测试代码
    • chore:构建过程或辅助工具的变动
  • (可选的作用域):表示本次提交所涉及的模块或组件。可以根据实际情况选择是否使用。

  • <描述>:简洁明了地描述本次提交的目的。

  • [可选的正文]:可选项,用于提供更详细的说明和上下文。

  • [可选的脚注]:可选项,用于包含与提交相关的其他信息,比如关联的 Issue 编号。

以下是一些示例提交消息:

复制代码
feat: 添加用户注册功能

fix(auth): 修复身份验证逻辑错误

docs: 更新项目文档

通过遵循约定式提交的规范,可以提高团队成员之间的协作效率,更好地管理和维护代码库。同时,还可以结合自动化工具,例如使用 Commitizen 或者 Git 提交钩子,在提交时进行格式检查和验证。

相关推荐
SH的全栈笔记2 小时前
敲下 git add 的那一刻,.git 里多了什么
git·后端
正经教主4 小时前
【FDE系列】阶段2:Day 45(up详细版):综合实战 — Docker + Nginx + Git 完整部署与本周收官
人工智能·git·nginx·docker·fde
Change!!1 天前
git小乌龟,切换到新分支处理
git·git切到新分支,旧代码贮藏
LannyChung2 天前
PowerShell 下 git log 中文乱码的完整排查与解决
windows·git
import_random2 天前
[git]本地main,origin/main,远程main(关系2)
git
golang学习记2 天前
Zed Git重大更新:目录级对比支持分栏Diff
git·vscode·zed
阿俊-全栈开发2 天前
LikeShop 单商户高级版二开项目的 Git 分支管理与版本发布规范
git·likeshop·likeshop开源商城·likeshop多商户
努力弹琴的大风天2 天前
TortoiseGit 仓库不显示绿色对号解决方案
git·tortoisegit·图标显示
我不会插花弄玉2 天前
GitHub实操【由浅入深-Git】
git·github
说实话起个名字真难啊2 天前
Git常用小问题笔记
笔记·git·elasticsearch