Git提交代码注释规范
- feat(新功能):
- 新增代码文件:新功能相关的代码文件、模块等。
- 更新测试文件:添加新功能的测试用例。
- fix(修复):
- 修改代码文件:包含有问题代码的文件。
- 更新测试文件:修复问题的测试用例。
- docs(文档):
- Markdown 文件:更新项目文档、README、帮助文件等。
- 注释:更新代码中的注释,提供更详细的说明。
- style(代码样式):
- 代码文件:进行代码格式化、空格、缩进等调整。
- 配置文件:修改代码格式化工具的配置。
- refactor(重构):
- 修改代码文件:进行代码结构重组、函数抽取、变量重命名等。
- 更新测试文件:相应的更新测试用例。
- perf(性能优化):
- 修改代码文件:优化性能的代码更改。
- 更新测试文件:添加性能测试用例。
- test(测试):
- 新增或修改测试文件:添加新的测试用例或更新现有的测试。
- build(构建):
- 构建脚本:更新构建过程的脚本、配置等。
- ci(持续集成):
- CI/CD 配置文件:更新持续集成和持续部署的配置文件。
- chore(杂项):
- 配置文件:调整项目配置文件,如 Dockerfile、环境变量配置等。
- 脚本文件:更新构建、部署脚本。
- revert(回滚):
- 修改之前提交引入的问题,进行回滚操作。
- pr(Pull Request):
- 如果给其它项目提交合并代码的请求时,就说会提交一个PR。
- wip(Work In Progress ):
- 如果你要做一个很大的改动,可以在完成部分的情况下先提交,但说明WIP,方便项目维护人员知道你还在 Work,同时他们可以先审核已经完成的。
- upgrade
- 升级改造
转自:
https://www.cnblogs.com/CoderI/p/17640422.html
https://zhuanlan.zhihu.com/p/653317939