首页 > 其他分享 >Git提交代码注释规范

Git提交代码注释规范

时间:2024-01-24 16:45:49浏览次数:38  
标签:文件 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,同时他们可以先审核已经完成的。


                       

 

 

转自:

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

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

 

标签:文件,Git,测试,配置文件,代码,更新,注释,测试用例,提交
From: https://www.cnblogs.com/PrintY/p/17985016

相关文章

  • 四、掌握ArgoCD:安装、Gitlab集成和RBAC配置以实现无缝持续部署
    Gitlab集成    然后点击提交(saveapplication),将得到应用创建后的信息:  注册完成后,我们可以看到应用现在只有0个Clients,即还没有任何实例作为这个Application的实例进行认证:但不管怎么说,应用注册这一步我们算成功完成啦!GiveMeFive~用如下命令编辑con......
  • 22-有参转录组实战8-基因功能注释_GO_KEGG_swissprot_pfam_TFDB_iTAK
    #进行功能注释时,我们只用到蛋白文件,就是上一期提取序列的文件“Ptri.protein.fa”。#使用命令“grep-c">"Ptri.protein.fa”统计下“>”的个数,发现有52400个。#新建文件夹“swissprot”wgethttps://ftp.uniprot.org/pub/databases/uniprot/current_release/knowledgebase......
  • 突然连不上Github或者连接超时的解决办法
    问题描述当进行仓库pull或者push时,报错如下(连接失败/被拒绝/超时等):Failedtoconnecttogithub.comport443:Connectionrefused解决方法如下:方法一:关闭代理一开始查找解决方法以为是开梯子或者其他代理工具等原因,然后就试了重置代理或者取消代理的方式gitconfig--global-......
  • git 命令简洁版
    gitinit#初始化本地git仓库,需要被管理的代码文件或者目录,都放到本地git仓库中gitstatus#查看本地仓库中的文件和文件夹的状态gitadd文件名称(或者.)#通过git管理某个文件或者所有文件及目录配置用户名和邮箱$gitconfig--globaluser.name<用户名>$gitconfig-......
  • GIT版本管理工具教程
    GIT版本管理工具教程一Git初始化下载安装,下载地址:https://git-scm.com/downloads每个系统的都有(linux、mac、windows等),看官网的安装教程,很详细,此处我以windows来练习首先创建一个文件夹,这个文件夹就是我们将来通过git来管理的所有文件的存放地点。在文件夹中右键......
  • git笔试面试题
     收集整理几个git相关的笔试面试题 1、你们公司版本是如何管理的?细说一下 2、如何创建分支? 3、gitclone、gitpull、gitfetch、gitpush的区别是? 4、merge和rebase的区别是? 5、gitpull和gitpull--rebase的区别是? 6、代码提交到本地仓库后,发现提交日志写......
  • 如何从 Jira 成功迁移到极狐GitLab,看这个就够了!
    Atlassian之前表示,到2024年2月会全面终止对于其服务器端产品的支持。随着JiraServer的生命周期即将结束,众多组织都在考虑将其敏捷项目管理工具从Jira迁移到极狐GitLab,以便简化整个组织的流程。让团队使用新的敏捷规划工具似乎是令人畏惧的,但是这种改变是值得的。极狐Gi......
  • Gitlab端口变更
     自己云服务器的80和8080端口都已经被使用,只能被迫修改gitlab监听的端口external_url'http://172.17.30.23:8077'#这里一定要加上http://nginx['listen_port']=8077gitlab_rails['smtp_enable']=truegitlab_rails['smtp_address']="smtp.qq.com&......
  • Git远程链接仓库命令
    1)查看仓库已配置的远程源>:gitremote>:gitremote-v 2)查看remote命令帮助文档>:gitremote-h 3)删除远程源>:gitremoteremove源名eg:gitremoteremoveorigin 4)添加远程源>:gitremoteadd源名源地址>:gitremoteaddorginhttps://gitee.......
  • git 查看某一文件的修改记录
    要查看某一文件的修改记录,可以使用以下命令: ```gitlog<文件路径>``` 例如,要查看文件`index.html`的修改记录,可以使用以下命令: ```gitlogindex.html```  这将显示该文件的所有提交记录,包括提交的作者、日期和提交消息。你可以使用上下箭头浏览记录,并按......