Git提交代码注释规范

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


                       

 

 

转自:

https://www.cnblogs.com/CoderI/p/17640422.html

https://zhuanlan.zhihu.com/p/653317939

 

posted @ 2024-01-24 16:37  PrintY  阅读(1321)  评论(0编辑  收藏  举报