📌  相关文章
📜  更改消息提交 git - Shell-Bash (1)

📅  最后修改于: 2023-12-03 15:10:32.860000             🧑  作者: Mango

更改消息提交 git - Shell-Bash

使用Git进行版本控制是每个程序员都必须掌握的一项技能。提交(commit)是Git中最基本的操作之一,它允许开发人员将代码更改推送到本地存储库,以保存版本历史记录。一个好的提交信息(commit message)可以使代码更改更易于理解和维护。

更改消息提交的标准形式

Git提交消息的标准形式由三部分组成:标题,正文和页脚。

  <类型>:[空格]<主题>

  [空格]

  <正文>

  [空格]

  <页脚>
  • 标题(type):指定更改的类型,应该是以下中的一个

    • feat: 新功能
    • fix: Bug 修复
    • docs: 文档更新
    • style: 代码格式化、删除空格等
    • refactor: 代码重构,不涉及新功能或Bug修复
    • test: 添加或修改测试用例
    • chore: 不涉及源文件或测试用例的更新,如构建过程、依赖管理等
  • 主题(subject):简单描述更改的内容,应该以动词开头并清楚且简洁。

  • 正文(body):更改的详细描述,应该提供更改的原因、解决方法以及潜在影响等信息。

  • 页脚(footer):配置信息,例如任务编号(issue)或转义字符(escape sequences)。

示例
feat: 添加新的用户登录功能

添加了新的用户登录功能,该功能可以通过邮箱和密码进行验证。采用了bcrypt算法,保证了用户密码的安全性。

close #123

本提交消息的类型为 feat,主题是添加新的用户登录功能,并在页脚中包含了关闭任务号为#123的信息。

提交消息的使用

提交消息为一条消息,通常应在下面使用过程中完成。

$ git add .
$ git status

$ git commit -m "<type>: <subject>"
或者使用可视化界面

对于一些不熟悉命令行的同学,也可以在可视化界面中进行更改消息提交。

git commit message

总结

本文介绍了更改消息提交的规范形式,它可以帮助开发人员更好地组织代码更改历史。始终让提交消息简短、有用和规范是一个好的项目实践,它允许开发人员更轻松地了解自己和他人的工作。