项目的git commit message给我几个优秀的例子以及多个commit后的pull request怎么写也给我例子。如果一个pull request里面包含一些彼此之间没有关系的提交应该如何描述?
优秀的git commit message例子:
- feat: 添加用户登录功能
- fix: 修复用户信息保存时的bug
- docs: 更新README.md文件
- refactor: 重构代码结构,提高性能
- chore: 更新依赖库版本
多个commit后的pull request应该包含以下内容:
- 标题:简要描述本次提交的内容
- 描述:详细描述本次提交的内容,包括修改了哪些文件,修改的原因等
- 测试:说明本次提交是否经过测试,测试结果如何
- 相关issue:如果本次提交与某个issue相关,请在此处说明
例子:
标题:添加用户管理功能
描述:本次提交添加了用户管理功能,包括用户列表展示、用户信息编辑、用户信息删除等。修改了以下文件:
- user_list.html
- user_edit.html
- user_delete.html
测试:本次提交已经经过测试,测试结果正常。
相关issue:无
如果一个pull request里面包含一些彼此之间没有关系的提交,可以将每个提交单独描述,或者将它们归为一个大的主题,例如“更新用户管理功能”,然后在描述中说明具体修改了哪些部分
原文地址: https://www.cveoy.top/t/topic/emOm 著作权归作者所有。请勿转载和采集!