首页 > 其他分享 >Git提交规范

Git提交规范

时间:2024-03-14 23:25:07浏览次数:25  
标签:Git 规范 提交 Commit commit message

意义及现状

在开发过程中,Git每次提交代码,都需要写Commit message(提交说明),规范的Commit message有很多好处:

  • 方便快速浏览查找,回溯之前的工作内容
  • 可以直接从commit 生成Change log(发布时用于说明版本差异)

目前我们并没有对commit message进行规范,造成以下麻烦:

  • 每个人风格不同,格式凌乱,查看很不方便
  • 部分commit没有填写message,事后难以得知对应修改的作用

规范Commit message不仅能解决上述问题,而且基本没有副作用和学习成本,应该尽早加上

规范方式

为了实现规范,我们使用commitlinthusky 来进行提交检查,当执行git commit时会在对应的git钩子上做校验,只有符合格式的Commit message才能提交成功。
为了方便使用,增加了commitizen支持,使用cz-customizable进行配置。支持使用git cz替代git commit。
有兴趣的小伙伴可以查阅相关文档。
PS: 之后如果要推行代码规范,也可以使用husky来在其他的Git钩子(如pre-push等)上进行eslint等校验。

Commit message 格式

为了方便使用,我们避免了过于复杂的规定,格式较为简单且不限制中英文:

复制代码<type>(<scope>): <subject>
// 注意冒号 : 后有空格
// 如 feat(miniprogram): 增加了小程序模板消息相关功能

scope选填表示commit的作用范围,如数据层、视图层,也可以是目录名称 subject必填用于对commit进行简短的描述 type必填表示提交类型,值有以下几种:

● feat - 新功能 feature
● fix - 修复 bug
● docs - 文档注释
● style - 代码格式(不影响代码运行的变动)
● refactor - 重构、优化(既不增加新功能,也不是修复bug)
● perf - 性能优化
● test - 增加测试
● chore - 构建过程或辅助工具的变动
● revert - 回退
● build - 打包

标签:Git,规范,提交,Commit,commit,message
From: https://www.cnblogs.com/lymf/p/18074254

相关文章

  • 小米便签AS部署之Git的基本使用
    1项目测试截图及仓库地址https://gitee.com/magicfatblink/Notes-master2小米便签代码的移植2.1IDE的准备2.1.1AS版本选择由于小米便签是一个很老的项目,距最后一次提交已经有13年的历史了当时Android主流开发软件还是eclipse,本项目原始代码也是基于eclipse运行的,所......
  • 关于Git小白应该知道的事
    听说学会使用Git版本控制,对写程序很有帮助,今天花了一点时间学习体验了一下起初我的配置了虚拟机,安装Linux之CentOS,使用vscode连接使用,对用惯了Windows来说,非常友好了写代码,管理文件,包括调试都很方便,在网上看过视频讲解后,也安装上了GIT,还建了一个测试仓库(Repository)也把代码搞......
  • 大数据清洗二之增加行政编码和规范到去区或县
    我因为准备考研,所有就算抽空整整建民老师的大数据作业,今天在选修课上把第二阶段的规范到区和县还有增加行政区域编码。代码如下:importjsonimportpymysqlimportpandasaspdimportrequestsfromsqlalchemyimportcreate_engine#连接MySQL数据库conn=pymysql.conn......
  • 如何依赖机器人安装极狐GitLab
    本文作者:徐晓伟GitLab是一个全球知名的一体化DevOps平台,很多人都通过私有化部署GitLab来进行源代码托管。极狐GitLab是GitLab在中国的发行版,专门为中国程序员服务。可以一键式部署极狐GitLab。极狐GitLab依赖机器人dependabot-gitlab使用dockercompose安装说明......
  • 【掌握版本控制:Git 入门与实践指南】远程操作|标签管理
                             ......
  • 极狐GitLab和企业微信的集成实战
    企业微信是国内企业使用较多的即时通信工具,极狐GitLab自16.2就和企业微信做了集成,极狐GitLab相关的变更都可以直接发送到对应的企业微信群,然后开发人员去处理。仅需两步即可完成极狐GitLab和企业微信的集成。前提由于该功能使用FeatureFlagwecom_integration控制,当......
  • 自学Python第一步,记住这7大编码规范
    一、缩进每一级缩进4个空格。续行应该与包裹元素对齐,要么使用圆括号,方括号,花括号内的隐式行连接来垂直对齐,要么使用挂行缩进对齐。当使用挂行缩进对齐时,应该考虑到第一行不应该有参数,以及使用缩进以区分自己是续行。对齐缩进(左右括号对齐)deflong_function_name(var_......
  • 业界首份 GitLab DevSecOps 线上成熟度评估邀您来测
    GitLab是一个全球知名的一体化DevOps平台,很多人都通过私有化部署GitLab来进行源代码托管。极狐GitLab是GitLab在中国的发行版,专门为中国程序员服务。可以一键式部署极狐GitLab。DevSecOps是极狐GitLab的安全合规功能,包含SAST(静态应用程序测试)、DAST(动态应用程序......
  • 【AIGC调研系列】Github Copilot进行pytest自动化测试的实践经验
    GitHubCopilot可以用于pytest自动化测试的实践和使用方法。此外,Copilot可以在很多情况下仅通过注释或函数名就能实例化出完整的代码,这表明它也可以用于补充测试用例[5]。具体到pytest框架,它是一个非常容易上手的自动化测试框架,具有丰富的资料文档和第三方插件,可以自定义扩展......
  • 前端提交数据后http状态码400
    报错如下:分析原因:前端Cookie使用过多,储存数据过大 解决方案:方案一:Nginx配置文件nginx.conf中把请求头内存调大client_header_buffer_size32k;large_client_header_buffers432k;方案二:前端删除部分Cookie,用H5中的本地储存localStorage代替<!DOCTYPEhtml><html>......