GitHub Pull Request 提交规范:撰写完美的 Commit Message
撰写规范的 GitHub Pull Request Commit Message 对于团队协作和代码维护至关重要。一个清晰、简洁的 Commit Message 可以帮助其他人理解你的改动,并方便代码审查和回滚。
以下是一份编写规范 Commit Message 的指南:
-
标题:
- 简洁明了,描述所做的更改或修复的问题,以动词开头,使用命令式语气。
- 例如:'Fix: 修复登录页面错误'、'Add: 新增用户注册功能'、'Refactor: 重构代码结构'。
-
空一行。
-
正文:
- 如果需要的话,可以在正文中进一步解释更改的原因、背景和实现方式。
- 用清晰的语言描述改动,并使用合适的格式,例如代码片段或表格。
-
空一行。
-
底部:
- 在底部添加一个注释,以'关联'加上相关的 GitHub issue 号。
- 例如:'关联 #1234'、'关联 issues #1234, #5678'。
示例:
Add feature to search users by username
The new feature allows users to search for other users by their username. This is useful for finding friends or people with similar interests.
Related to #1234
遵循以上规范,可以使你的 Commit Message 更易于理解,并提高代码库的维护效率。
原文地址: https://www.cveoy.top/t/topic/miAo 著作权归作者所有。请勿转载和采集!