首页 > 其他分享 >git的提交规范

git的提交规范

时间:2025-01-10 11:56:30浏览次数:1  
标签:git 示例 作用域 更改 规范 提交 feat

git的提交规范包括两个字段:type(必需)和subject(必需)

type用于说明 commit 的类别,只允许使用下面9个标识。

feat: 新功能(feature)

fix: 修补bug

docs: 文档(documentation)

style: 格式(不影响代码运行的变动)

refactor: 重构(即不是新增功能,也不是修改bug的代码变动)

chore: 构建过程或辅助工具的变动

revert: 撤销,版本回退

perf: 性能优化

test:测试

improvement: 改进

build: 打包

ci: 持续集成

 

subject是 commit 目的的简短描述,不超过50个字符。

example:

    feat(example): 订单详情增加导出功能

 

    -订单详情新增导出功能

 

 feat() 括号内的内容通常用来指明该功能更改的影响范围或上下文

作用域的选择

选择合适的作用域取决于你的项目结构和团队约定。以下是几个例子:

  • 按模块或功能区划分:如果你的项目由多个独立的功能模块组成,那么可以在括号内填写模块名。

    • 示例:feat(user-auth): 添加两步验证支持
  • 按前端框架组件划分:对于使用如 React, Vue 等前端框架的项目,可能会按照组件来组织。

    • 示例:feat(Header): 增加导航栏的新按钮
  • 按后端服务或API端点划分:如果是在服务端工作,可能根据API端点或服务命名。

    • 示例:feat(api/v2/users): 支持批量用户创建
  • 按文件夹或目录划分:有时也直接使用文件夹名称作为作用域。

    • 示例:feat(src/components): 更新组件样式
  • 按技术或库划分:当更改特别针对某个库或技术时,也可以用它作为作用域。

    • 示例:feat(express): 升级到Express 5.0
  • 其他自定义作用域:根据项目的具体需求,还可以使用其他任何有助于描述更改范围的标识符。

注意事项

  • 遵循团队规范:确保你遵循所在团队或项目已有的提交信息格式和约定。
  • 保持一致性:一旦确定了作用域的规则,尽量在整个项目中保持一致。
  • 简洁明了:作用域应该简短且具有描述性,避免过长或过于模糊。

括号中的内容是为了提供额外的上下文,帮助更好地理解和分类提交。因此,选择能够清晰表达更改影响范围的词汇是非常重要的。

标签:git,示例,作用域,更改,规范,提交,feat
From: https://www.cnblogs.com/chengsongbiao/p/18663711

相关文章

  • GitLab安装与配置
    由于图片和格式解析问题,为了更好阅读体验可前往阅读原文对于gitlab的安装本人都是在arm架构Centos7.9虚拟机上进行的,请悉知本人安装环境,或者与本人的环境保持一致,以便产生不必要的疑惑这里使用docker安装Gitlab,机器上需要先安装docker,如果你还不知道docker,可以先看看我的往期......
  • 【JAVA编程】通过自定义注解与AOP防止接口重复提交实战
    引言在Web应用开发中,特别是在处理表单提交或API调用时,可能会遇到用户因网络延迟、按钮多次点击等原因导致的重复提交问题。为了解决这一问题,通常的做法是在前端禁用提交按钮,或者在后端使用唯一令牌(Token)机制来确保请求的唯一性。然而,这些方法往往需要针对每个可能的重复提交场景......
  • [1087] GitHub Copilot in VSCode
    Ref: QuickstartforGitHubCopilotRef: PromptengineeringforGitHubCopilotRef: ConfiguringGitHubCopilotinyourenvironmentRef:GettingstartedwithpromptsforCopilotChat  ......
  • Git-SSH配置
    Git-SSH配置(来自个人早期的OneNote笔记,目前已经迁移到语雀);语雀 Git连接(可创建一个Key同时使用GitEE、GitHub、GitLab等)创建SSHkey将邮件地址替换为你Gitee或者Github使用的邮件地址(GitHub和GitEE的邮箱地址相同也没事)ssh-keygen-trsa-C****"xxx@xxx.co......
  • [1085] GitHub Resources and Tools
    Ref:AboutGitHubandGitAboutGitHubGitHubiscloud-basedplatformwhereyoucanstore,share,andworktogetherwithotherstowritecode.Storingyourcodeina"repository"onGitHuballowsyouto:Showcaseorshareyourwork.Trackand......
  • qianfeng git
    一.补充初始化本地和远程项目后,自己先执行远程仓库提示的代码,不要先让其他人往远程仓库推送代码。我的测试:【reset是毁尸灭迹的操作,哈哈哈】gitreset--soft:会保留工作区和暂存区的修改,提交记录会回退到指定的版本【只动版本库】gitreset--mixed:会保留工作区的修改,把add......
  • nginx 日志规范化意义及实现!
    一.场景:     首先,我们需要明白log的重要性。服务的log,将是我们分析用户行为的不可缺少的一个核心组件;通过log我们可以获取用户的访问量,qps,rt,pv,状态,通过log进行相应的监控,故障排除,追踪,定位等。     nginxlog的配置方式,相信做过运维的同学都使用过,曾经......
  • 2025 GitCode 开发者冬日嘉年华:AI 与开源的深度交融之旅
    在科技的浪潮中,AI技术与开源探索的火花不断碰撞,催生出无限可能。2025年1月4日,由GitCode联合CSDNCOC城市开发者社区精心打造的开年首场开发者活动:冬日嘉年华在北京中关村•鼎好DH3-A座22层盛大举行,为AI技术爱好者和开源世界探索者带来了一场别开生面的交流派......
  • Git代码提交规范
    commitmessage=subject+:+空格+message主体属性描述简单示例feat新功能feat:增加用户注册功能fix修复bugfix:修复登录页面崩溃的问题docs文档变更docs:更新README文件style代码风格变动(不影响代码逻辑)style:删除多余的空行refactor......
  • GitHub打不开的解决方案(乱测版)
    今天想访问GitHub一直进不去。如图:百度测试好多方法,终于找到成功的,记录下。解决方法:WIndows+R打开CMD,然后ping  github.com:  然后打开 C:\Windows\System32\drivers\etc对hosts文件添加信息:保存后刷新NDS,ipconfig/flushdns: 然后访问官网成功: 附:刚开始......