关于git代码上传的规范以及commit message 模板的自动生成

最近在整理一些关于git 上传代码到gerrit上以及审核的一些规范。(只是个人认为比较合理的部分,有不合适的地方还希望各位原谅!)

1. 写在上传之前的话:

编写完代码之后在即将上传前请检查以下是否合理:

  • 1.编译运行是否可以编译通过(需要以apk方式放入源码的apk在android stuido中编译(注意编译release 签名版的),如果依赖服务器编译的。即使在android studio中编译通过,也需要在服务器中单独编译验证一下)。
  • 2.检查上传改动的代码是否已经format格式化。
  • 3.检查是否有添加详细的注释。

上传命令:

    1. git status (查看即将添加的文件是否为自己修改的)
    1. git add file
    1. git commit (这里不要用-m去添加message)
    1. 进入编辑行,按照以下规则编辑message

如果是添加的新功能:

【添加功能】:[zs][app name]add a ....
              
以上分别代表:提交者名字缩写    对应修改的那个app       增加或修改了什么功能

【测试注意】可能带出来的一些问题或者做一些特殊的补充或者说明
【操作类型】修改或者新功能添加
【重要程度】一般or 重要or 非常重要
【影响产品】对应的影响的产品

如果是测试是修复的bug:

【解决问题】:[zs][APP][对应bug号]modify a ....
【测试注意】可能带出来的一些问题或者做一些特殊的补充或者说明
【对应bug号】93478 ...
【操作类型】修改或者新功能添加
【重要程度】一般or重要or非常重要
【影响产品】对应的影响的产品

:wq保存退出编辑
5.git push
6.代码push成功后在gerrit上检查是否有效,并打开对应文件检查修改部分是否为对应的自己的修改内容
注意:切记在修改代码中修改中增加了缩进空格之类的(优化代码格式除外)。这样会导致即使修改了一行,gerrit上记录也会显示许多行。(建议每次准备上传前都是用快捷键格式化一下代码!)

2.关于git 提交模板的配置
  • 1.在根目录建立模板文件,(文件名可以自己定义,这里叫testtemplate)内容如下:(此文件内容可以根据自己公司的要求自行定义)
【解决问题】:[zs][APP][对应bug号]modify a ....
【测试注意】可能带出来的一些问题或者做一些特殊的补充或者说明
【对应bug】93478 ...
【操作类型】修改或者新功能添加
【重要程度】一般or重要or非常重要
【影响产品】影响产品
  • 2.设置模板命令如下(文件名为上面步骤的,是testtemplate)
    git config commit.template [模板文件名] //这个命令只能设置当前分支的提交模板
    git config --global commit.template [模板文件名] //这个命令能设置全局的提交模板,注意global前面是两杠

    例如:git config --global commit.template testtemplate

  • 3.设置文本编辑器。
    git config --global core.editor [编辑器名字]
    例如:git config --global core.editor vim

  • 4.设置完毕,以后提交代码时,git add 然后git commit 之后模板就会出现。直接可以编辑message。

到此,配置结束。谢谢!

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

假装多好123

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值