Git Commit Message 和 Pull Request 写作最佳实践 - 优秀案例与技巧

Git Commit Message 和 Pull Request 写作最佳实践

优秀 Git Commit Message 案例

以下是一些优秀的 Git commit message 案例，可供参考：

1. 'feat: 添加用户登录功能'
2. 'fix: 修复用户信息保存时的 bug'
3. 'docs: 更新 README.md 文件'
4. 'refactor: 重构代码结构，提高性能'
5. 'chore: 更新依赖库版本'

多个 Commit 后 Pull Request 的写作规范

多个 commit 后提交 Pull Request 时，应该包含以下内容：

1. 标题: 简要描述本次提交的内容。
2. 描述: 详细描述本次提交的内容，包括修改了哪些文件、修改的原因等。
3. 测试: 说明本次提交是否经过测试，测试结果如何。
4. 相关 issue: 如果本次提交与某个 issue 相关，请在此处说明。

例子:

标题: '添加用户管理功能'

描述: '本次提交添加了用户管理功能，包括用户列表展示、用户信息编辑、用户信息删除等。修改了以下文件：

• user_list.html
• user_edit.html
• user_delete.html'

测试: '本次提交已经经过测试，测试结果正常。'

相关 issue: '无'

处理多个无关 Commit 的 Pull Request

如果一个 Pull Request 包含一些彼此之间没有关系的提交，可以将每个提交单独描述，或者将它们归为一个大的主题，例如 '更新用户管理功能'，然后在描述中说明具体修改了哪些部分。