git commit格式 git branch命名格式

发布时间 2023-09-04 16:48:20作者: eehongzhijun

git commit格式

在Git中,git commit命令用于将文件的更改提交到版本控制仓库。提交消息是非常重要的,因为它记录了对项目的更改的描述和目的。提交消息的格式通常遵循一些约定,以便更容易理解和维护项目的历史。以下是一种常见的提交消息格式:

<类型>(可选范围): <主题>

<正文>

# 评论或注释(可选)

<类型>(必需):表示此次提交的类型。常见的提交类型包括:
feat(新功能):添加新功能或功能改进。
fix(修复):修复错误或问题。
docs(文档):更新文档。
style(样式):对代码样式进行更改,如格式化代码,空格,分号等,不影响代码逻辑。
refactor(重构):对现有代码进行重构,不添加新功能或修复错误。
test(测试):添加或修改测试代码。
chore(杂项):对构建过程或辅助工具和库的更改。

(可选范围):可选项,表示此次提交的范围或影响的部分。这可以是一个文件、模块、功能或任何其他相关信息。

<主题>(必需):简洁明了地描述了此次提交的目的。主题应该清楚,准确,不宜太长。

<正文>:可选项,用于提供有关此次提交的详细信息。您可以在正文中提供更多上下文、背景信息或解释为什么进行了这次更改。

评论或注释:可选项,用于添加其他注释或评论,如引用问题跟踪号码或其他相关信息。

下面是一个示例提交消息:

feat(user-auth): 添加用户身份验证功能

这个提交添加了用户身份验证功能,包括注册、登录和注销功能。
新功能允许用户创建帐户并登录以访问特定页面。

# 关闭问题#123

请注意,提交消息的格式可以根据您的项目和团队的偏好而有所不同。重要的是要保持一致性,以便更容易理解和管理项目的历史。

git branch 命名格式

在Git中,分支的命名格式通常是自由的,但是有一些常见的约定和最佳实践,以帮助团队更好地组织和管理分支。以下是一些常见的分支命名格式和最佳实践:

主分支:通常,主分支(主要是master或main分支)用于存储生产代码,因此命名通常较为简单。一般来说,不需要在主分支上进行频繁的改动,因此命名可以是 master 或 main。

特性分支:用于开发新功能或进行较大的改动。通常采用以下命名约定:
使用 feature/ 前缀,然后跟随具体的特性或任务名称,用短横线或下划线分隔单词,例如:
feature/user-authentication 或 feature/add-shopping-cart。

修复分支:用于修复问题或漏洞。通常采用以下命名约定:
使用 fix/ 前缀,然后跟随具体的问题或漏洞编号或描述,例如:fix/issue-123 或 fix/typo-in-readme。

热修复分支:用于紧急修复生产环境中的问题。通常采用以下命名约定:
使用 hotfix/ 前缀,然后跟随具体的问题或漏洞编号或描述,例如:hotfix/issue-456 或 hotfix/security-patch。

发布分支:用于准备发布新版本。通常采用以下命名约定:
使用 release/ 前缀,然后跟随版本号或发布名称,例如:release/1.0.0 或 release/beta-release。

持续集成/持续交付分支:用于持续集成和持续交付流程。通常采用以下命名约定:
使用 ci-cd/ 前缀,然后跟随流程或环境名称,例如:ci-cd/staging 或 ci-cd/production。

个人分支:在个人开发时,可以使用您自己的名字或用户名作为前缀,以示区分,例如:john/feature-branch 或 jane/bug-fix.

参考链接:

Commit message 和 Change log 编写指南

A Simplified Convention for Naming Branches and Commits in Git

Git Branch Naming Convention