1.提交消息规范
使用提交消息模板 :
创建一个提交消息模板,包括三个部分:header、body和footer。
示例模板:1 2 3 4 5 6 7 8 9 10 11 <类型> (<范围> ): <标题> <空一行> <详细描述更改、解决的问题、相关issues等> <空一行> <关闭相关issues的标记>
提交类型 :
类型用于说明 commit 的目的,常见的 commit 类型包括:feat(新特性)、fix(修复问题)、docs(文档更新)、style(样式更新)、refactor(代码重构)、test(测试更新)等。
范围 :
范围用于说明 commit 影响的范围,如 frontend、backend、database、security 等。
标题 :
标题应简洁明了,准确反映 commit 的主要目的。
主体 :
主体部分应详细描述 commit 的更改内容、解决的问题和相关的 issues。
可以使用 markdown 格式来增强提交消息的可读性。
底部 :
底部可以标记关闭相关的 issues。例如:”Closes #123”,”Fixes #456”。
遵循一致的命名约定 :
尽量使用小写字母和破折号,如:”feat-add-comment-function”。
避免使用大写字母和下划线。
不要在提交消息中包含特殊字符 :
避免在提交消息中使用特殊字符,如中文、特殊符号等,以免引起解析错误。
保持简洁 :
使用英文 :
虽然可以使用其他语言,但英文是 Git 社区中最常用的语言,使用英文可以确保更广泛的参与和理解。
2. 实际提交步骤 2.1 初始化仓库
2.2 添加文件到仓库
2.3 提交更改
这将启动一个文本编辑器,您可以在这个编辑器中输入提交消息。如果您在命令行中直接输入提交消息,也可以直接按 Enter
键。
2.4 查看提交历史
2.5 创建分支 1 git branch feature-user-registration
2.6 切换到新分支 1 git checkout feature-user-registration
2.7 继续开发 在分支上继续工作,进行多次提交。
2.8 合并分支 1 git merge feature-user-registration
2.9 推送更改到远程仓库
2.10 推送到特定分支 如果需要将更改推送到特定的远程分支,可以指定分支名称:
1 git push origin feature-user-registration
2.11 删除本地分支 在合并分支后,可以删除本地分支:
1 git branch -d feature-user-registration
2.12 删除远程分支 如果不再需要远程分支,可以删除它:
1 git push origin --delete feature-user-registration
提交消息实例 1 2 3 feat(auth): Implement user registration form Added a new form for user registration that collects name, email, and password. Added basic validation to ensure data integrity. Closes #247
在这个实例中:
feat(auth)
表示这是一个新特性(feature)提交,它影响了认证(auth)模块。
Implement user registration form
是标题,简洁地描述了提交的目的。
主体部分详细描述了新用户注册表单的实现,包括收集的信息类型和添加的验证。
底部标记了一个相关的 issue(#247),表示这个问题已经通过这个提交解决了。