【Github】编写优秀的 Git 提交备注信息：完整指南

前言

在软件开发中，有效的 Git 提交备注信息是团队协作和代码维护的关键部分。一个明确的提交信息能够为你的团队成员提供有关代码变更的关键信息，使代码的历史和变更更加透明。GitHub社区已经约定了一套常用的 Emoji 图标代码，用于在提交信息中传达更多的上下文和情感，让你的提交信息更加明晰和生动。

提交信息类型

以下是一些常见的提交信息类型：

1. fix: 修复了 bug，错误或问题
2. add: 添加了新的功能，文件，代码等
3. update: 更新了现有功能，文件，代码等
4. remove: 移除了不再需要的代码，文件，功能等
5. refactor: 重构了代码，优化结构，性能或可读性，但没有更改功能
6. docs: 更新了文档，如注释，README等
7. style: 更新了代码样式，如缩进，空格，命名等，没有影响功能
8. test: 添加，更新或修复测试用例
9. perf: 提高了代码性能方面的更改
10. merge: 合并分支或解决冲突
11. revert: 撤销之前的提交

这些消息类型有助于在提交历史中提供更多的上下文和理解，使团队成员能够更容易地追踪和理解项目中的更改。

Emoji 图标代码

GitHub 上有一套约定俗成的 Emoji 使用规范，用于在提交信息中传达更多的上下文和情感。以下是一些常用的 Emoji 图标代码和它们的说明：

Emoji	Emoji Code	Commit Explanation
🎨	🎨	改进代码结构/代码格式
⚡️	⚡️	提升性能
🐎	🐎	提升性能
🔥	🔥	移除代码或文件
🐛	🐛	修复 bug
🚑	🚑	重要补丁
✨	✨	引入新功能
📝	📝	撰写文档
🚀	🚀	部署功能
💄	💄	更新 UI 和样式文件
🎉	🎉	初次提交
✅	✅	更新测试
🔒	🔒	修复安全问题
🍎	🍎	修复 macOS 下的问题
🐧	🐧	修复 Linux 下的问题
🏁	🏁	修复 Windows 下的问题
🤖	🤖	修复 Android 下的问题
🍏	🍏	修复 iOS 下的问题
🔖	🔖	发行/版本标签
🚨	🚨	移除 linter 警告
🚧	🚧	工作进行中
👷	👷	添加 CI 构建系统
💚	💚	修复 CI 构建问题
⬆️	⬆️	升级依赖
⬇️	⬇️	降级依赖
📌	📌	将依赖项固定到特定版本
📈	📈	添加分析或跟踪代码
♻️	♻️	重构代码
🐳	🐳	Docker 相关工作
🌐	🌐	国际化与本地化
➕	➕	增加一个依赖
➖	➖	减少一个依赖
🔧	🔧	修改配置文件
🔨	🔨	重大重构
✏️	✏️	修复 typo
💩	💩	写了辣鸡代码需要优化
⏪	⏪	恢复更改
🔀	🔀	合并分支
📦	📦	更新编译的文件或包
👽	👽	由于外部API更改而更新代码
🚚	🚚	移动或者重命名文件
📄	📄	增加或更新许可证书
💥	💥	引入突破性的变化
🍱	🍱	增加或更新资源
👌	👌	由于代码审查更改而更新代码
♿️	♿️	改善无障碍交互
💡	💡	给代码添加注释
🍻	🍻	醉醺醺地写代码…
💬	💬	更新文本文档
🗃	🗃	执行与数据库相关的更改
🔊	🔊	增加日志
🔇	🔇	移除日志
👥	👥	增加贡献者
🚸	🚸	优化用户体验、可用性
🏗	🏗	结构变动
📱	📱	做响应式设计
🤡	🤡	嘲弄事物
🥚	🥚	增加彩蛋
🙈	🙈	增加或更改gitignore
📸	📸	增加或更新截图
⚗️	⚗️	尝试新东西
🔍	🔍	SEO优化
☸️	☸️	关于Kubernetes的工作
🏷	🏷	增加类型（Flow、Typescript）

这些 Emoji 图标代码能够让你的提交信息更加直观地传达出你的代码变更的目的和性质。在使用 Git 提交信息时，你可以根据实际情况尝试使用这些Emoji图标代码，为你的提交信息增加一些个性化的标记。

编写优秀的提交信息

除了 Emoji 图标代码，一个好的提交信息还应该包括简洁但具体的描述，能够让其他开发者明确地了解你的代码变更。好的提交信息应该回答以下几个问题：

1. 这次提交做了什么改变？
2. 为什么要做这个改变？
3. 这个改变有什么影响？

通过合理使用 Emoji 图标代码和清晰的描述，你可以编写出更加优秀的 Git 提交备注信息，为团队协作和代码维护做出贡献。

总结

在开发中，良好的 Git 提交信息不仅可以帮助团队更好地管理代码变更，还能够提升协作效率。通过使用 Emoji 图标代码和清晰的描述，你可以让你的提交信息更加生动和有趣，为项目的历史留下有价值的记录。

感谢

git emoji来源于该网站git emoji