实际工作中 Git Commit 代码提交规范是什么样的？
【摘要】 前言Git 是我们日常工作中使用最为广泛的分布式版本代码控制系统，因此在我们的实际工作中，git commit 代码提交规范能够让每一次代码提交都变得有据可循，方便后续的代码审查、问题追踪和版本管理。同时，规范的提交信息也能够为自动化工具提供便利，如生成变更日志、自动化部署等。git commit 规范写法示例首先我们一起来看看行业统一认可且标准的 angular 项目的 git commi...
前言
Git 是我们日常工作中使用最为广泛的分布式版本代码控制系统，因此在我们的实际工作中，git commit 代码提交规范能够让每一次代码提交都变得有据可循，方便后续的代码审查、问题追踪和版本管理。同时，规范的提交信息也能够为自动化工具提供便利，如生成变更日志、自动化部署等。
git commit 规范写法示例
首先我们一起来看看行业统一认可且标准的 angular 项目的 git commit 规范写法。
-
https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular
基本格式
首先一个规范的 git commit message 通常包含 Header、Body 和 Footer 三部分，各部分之间使用空行分隔。
<header>
// 空一行
<body>
// 空一行
<footer>
Header 必填
描述提交类型和简短说明。格式为：<类型>(<作用域>): <主题>(<type>(<scope>): <subject>)。
-
类型（Type）： 必填，指明本次提交的目的，如 feat 表示新开发的功能（feature）、fix 表示修复 bug、refactor 表示代码重构等。 -
作用域（Scope）： 可选，描述修改的影响范围，如模块名、功能名等，视项目不同而不同。 -
主题（Subject）： 必填，是 commit 简明扼要的提交描述。长度建议不超过 50 个字符。
feat(payment): 微信支付功能集成
Body 可选
详细说明本次 commit 修改的内容。使用空行分隔段落，保持可读性。
- 新增微信支付SDK依赖
- 实现支付结果回调处理
- 添加支付相关的单元测试
Footer 可选
主要用于关联 Issue、描述破坏性变更（BREAKING CHANGE）等。
Closes #889
BREAKING CHANGE: 旧版支付回调接口已废弃，需迁移至 /api/v2/callback
实际工作常用的 git commit 规范写法
其实在实际开发工作中很多时候我们主要关注和使用的是 git commit message 的 Header 部分。Header 通常包含了提交的类型、作用域和简短的主题描述，这些信息对于快速了解每次提交的内容和目的已经足够。
描述提交类型和简短说明。格式为：<类型>(<作用域>): <主题>。
格式：type(scope) : subject
常用的提交类型包括
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
【声明】本内容来自华为云开发者社区博主，不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源（华为云社区）、文章链接、文章作者等基本信息，否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容，欢迎发送邮件进行举报，并提供相关证据，一经查实，本社区将立刻删除涉嫌侵权内容，举报邮箱：
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
作者其他文章
评论（0）