Git 使用规范
Git 使用规范
- 一、版本控制的核心原则 🧭
- 二、分支策略(Branch Strategy) 🌿
- 2.1 分支类型与命名规范
- 2.2 可视化流程图
- 三、提交信息规范(Commit Message)✍️
- 3.1 提交格式
- 3.2 Type 类型说明
- 四、Tag 版本规范(Tag Strategy)🔖
- 4.1 命名格式
- 4.2 Tag 描述说明建议
- 五、推荐工作流(基于 Git Flow 简化 + 自动化)🔄
- 5.1 分支来源与合并目标
- 5.2 PR / MR 流程规范
- 六、CI/CD 与自动化建议(基于 Jenkins)📦
- 6.1 自动部署策略(推荐)
- 6.2 推荐工具集与 Jenkins 集成建议
- 6.3 Jenkins 流程示例
- 七、常见问题处理建议 📌
一、版本控制的核心原则 🧭
-
主分支(
main / master
)仅用于发布稳定版本,不用于日常开发。主分支始终保持可部署状态,确保版本稳定、可追溯。
-
所有功能开发必须在独立分支上完成。
每项功能、修复或改动应创建独立分支,避免协作冲突,提升开发效率与可维护性。
-
每次提交都应具备明确目的与描述。
保持提交记录清晰、结构化,便于代码审查、问题回溯和历史审计。
-
每次正式发布必须打 Tag,并提供详细的变更说明(Changelog)。
Tag 应遵循语义化版本控制(如
v1.2.3
),变更说明需涵盖新增、优化、修复等内容。 -
严禁直接向主分支推送代码,所有更改必须通过合并请求(Pull Request / Merge Request)提交。
所有合并操作需经由代码审核流程,确保团队协作质量与一致性。
二、分支策略(Branch Strategy) 🌿
2.1 分支类型与命名规范
分支类型 | 命名规则 | 示例 | 说明 |
---|---|---|---|
主分支 | main 或 master | master | 生产部署分支,仅用于发布版本和打 Tag,不参与开发 |
开发分支 | develop | develop | 日常开发集成分支,所有功能分支合并归此,保持阶段性稳定 |
功能分支 | feature/<模块>-<功能>-<任务ID> | feature/user-login-1234 | 单个功能开发分支,从 develop 创建,开发完成后合并回 develop |
修复分支 | bugfix/<模块>-<简要描述> | bugfix/userlist-null-pointer | 非紧急的缺陷修复,从 develop 创建,修复后合并回 develop |
热修复分支 | hotfix/<简要描述> | hotfix/fix-prod-login | 生产环境紧急修复,从 master 创建,修复后合并回 master 和 develop |
发布准备分支 | release/v<版本号> | release/v2.0.0 | 发布前版本封版处理,如补充文档、调整配置等,从 develop 创建,合并回 master 和 develop |
测试分支 | test | test | 用于部署测试环境,合并开发分支后测试用 |
灰度分支 | gray | gray | 用于灰度部署或内部试运行,通常从 release 或 master 派生 |
2.2 可视化流程图
feature/* ─┬─→ develop ─┬─→ test ─┬─→ release ─┬─→ gray ─→ master│ │ │ │└────────────┘ └── hotfix ───┘
三、提交信息规范(Commit Message)✍️
3.1 提交格式
<type>: <subject>// 示例
feat: 添加用户登录接口
fix: 修复订单状态不更新的问题
3.2 Type 类型说明
类型 | 说明 |
---|---|
feat | 新增功能(Feature) |
fix | 修复 Bug(Bug Fix) |
docs | 文档变更(例如 README、说明文档) |
style | 代码格式调整(空格、缩进、逗号等,不影响功能) |
refactor | 代码重构(既不新增功能也不修复 Bug) |
perf | 性能优化 |
test | 添加或修改测试代码 |
chore | 杂项更新(构建脚本、依赖管理、工具配置等) |
revert | 回滚,撤销之前的提交 |
build | 与构建系统或外部依赖相关的更改 |
ci | 持续集成/持续部署(CI/CD)配置文件修改 |
四、Tag 版本规范(Tag Strategy)🔖
4.1 命名格式
Tag 命名遵循语义化版本控制规范(Semantic Versioning,SemVer),格式如下:
v<主版本号>.<次版本号>.<补丁号>[-预发布标签]
版本类型 | 示例 | 说明 |
---|---|---|
正式版本 | v1.2.0 | 用于生产环境的正式发布版本 |
Beta 版本 | v1.2.0-beta.1 | 第一个 Beta 测试版本 |
RC 版本 | v1.2.0-rc.1 | 候选发布版本(Release Candidate) |
4.2 Tag 描述说明建议
打 Tag 时,建议使用带注释的 Tag,并附带简洁明确的版本说明,示例如下:
git tag -a v2.0.0 -m "Release v2.0.0: 添加国际化、多语言支持"
-
-a
表示创建带注释的 Tag -
-m
后面跟随的是该版本的说明信息,建议包含主要变更点,方便回溯与沟通
五、推荐工作流(基于 Git Flow 简化 + 自动化)🔄
5.1 分支来源与合并目标
开发阶段 | 分支来源 | 合并目标 | 说明 |
---|---|---|---|
功能开发 | develop | develop | 日常功能开发,持续集成 |
Bug 修复 | develop | develop | 非紧急缺陷修复 |
热修复 | master | master + develop | 紧急修复生产环境问题,双向合并 |
发布准备 | develop | release | 发布前版本冻结与准备 |
灰度发布 | release | gray | 灰度环境部署与验证 |
正式发布 | gray | master | 通过灰度验证后正式发布 |
5.2 PR / MR 流程规范
-
所有代码合并必须通过 Pull Request(PR)或 Merge Request(MR)完成。
-
合并前需至少一名开发人员审核通过。
-
合并提交信息应简洁明了,保证提交历史整洁。
六、CI/CD 与自动化建议(基于 Jenkins)📦
6.1 自动部署策略(推荐)
分支 | 部署环境 | 说明 |
---|---|---|
develop | 开发环境 | 持续集成开发版本自动部署 |
test | 测试环境 | 功能验证与集成测试环境 |
gray | 灰度环境 | 内部灰度发布与预发布验证 |
master (打 Tag) | 正式环境 | 正式生产环境部署,仅限打 Tag 时触发 |
6.2 推荐工具集与 Jenkins 集成建议
功能 | 工具示例 | Jenkins 集成建议 |
---|---|---|
提交校验 | Husky + Commitlint | 在 Jenkins 构建前通过钩子脚本验证提交规范 |
自动构建部署 | Jenkins Pipeline | 采用 Declarative Pipeline 编写自动化流水线,实现构建、测试、部署 |
代码静态检查 | ESLint / Prettier | 集成静态代码扫描插件(如 Warnings Next Generation)并生成报告 |
发布日志生成 | standard-version / semantic-release | 结合 Jenkins 任务自动生成版本日志,并触发自动发布 |
6.3 Jenkins 流程示例
-
触发机制:
-
监听代码仓库分支推送事件(webhook)
-
Tag 创建触发正式发布流程
-
手动触发构建
-
-
流水线步骤:
代码拉取 → 提交信息校验 → 代码静态检查 → 单元测试 → 构建 → 部署 → 发布通知
-
分支策略支持:
develop
、test
、gray
、master
分支分别配置对应流水线任务或参数化构建
七、常见问题处理建议 📌
问题 | 说明 | 建议 |
---|---|---|
忘记切分支开发 | 直接在 develop 写代码 | 严格要求功能必须基于 feature/* 分支 |
提交信息混乱 | update code 、fix 等 | 启用 Commitlint 校验,模板统一 |
主分支误操作 | 直接 push 到 master | 设置分支保护(Require PR、禁用 force push) |
多人合并冲突频繁 | 提交粒度大 | 频繁同步、提前拉 develop,保持分支短生命周期 |
相关文章:

Git 使用规范
Git 使用规范 一、版本控制的核心原则 🧭二、分支策略(Branch Strategy) 🌿2.1 分支类型与命名规范2.2 可视化流程图 三、提交信息规范(Commit Message)✍️3.1 提交格式3.2 Type 类型说明 四、Tag 版本规范…...

代码随想录第43天:图论4(最小生成树、拓扑排序)
一、冗余的边II(Kamacoder 109) from collections import defaultdict# 并查集 - 查找根节点(路径压缩) def find(fa, x):if fa[x] ! x:fa[x] find(fa, fa[x])return fa[x]# 并查集 - 合并两个集合,返回是否合并成功 …...

AI智能体|扣子(Coze)搭建【自动生成超高质量PPT】工作流
各位好久不见,你的失踪人口又回来了,已经超过一周的时间没有进行文章的更新了。 没更新的这段时间,主要还是因为工作上的调整以及身体生病所导致的停更,具体以后再说。 我们先讲今天的主要主题,使用 Coze 智能体一键生…...
list.sort(*, key=None, reverse=False)的两个问题
在python官网中,5.1. More on Lists,list.sort()是关于排序的方法。 list.sort(*, keyNone, reverseFalse) 中有两个问题: * 是什么意思key有什么作用 * 是什么意思 * 表示后面必须是关键字参数,具体见python官网4…...

文档处理的相关工具
目前网页端的文档,可以通过沉浸式翻译来进行翻译阅读和学习。 但是某些文献只有pdf下载的版本,所以需要一个免费的针对pdf的翻译工具。 保留公式和图片格式。 推荐一个pdf翻译的工具,可以自己部署使用。如果需要word版本,后面讨论…...

java基础(面向对象进阶高级)内部类
内部类 内部类概述、成员内部类 (了解) 内部类创建对象: 一定要继承外部类对象,才能创建内部类对象。 拓展:成员内部类访问外部类的成员特点: 成员内部类中,是否可以直接访问外部类的实例成员?? 当然可以啊&#x…...

使用Python,OpenCV,Tesseract-OCR对自己的运动数据图片进行识别及分析,并使用Matplotlib绘制配速图出来
使用Python,OpenCV,Tesseract-OCR对自己的运动数据图片进行识别及分析,并使用Matplotlib绘制配速图出来 1. 效果图2. 源码3. 全量源码及运动图片资源参考主要分为 目录下图片解析及读取;拼九宫格图片出来,可以自由配置(m*n)取决于自己有多少张运动图片遍历图片并进行运动…...

小白的进阶之路系列之七----人工智能从初步到精通pytorch自动微分优化以及载入和保存模型
本文将介绍Pytorch的以下内容 自动微分函数 优化 模型保存和载入 好了,我们首先介绍一下关于微分的内容。 在训练神经网络时,最常用的算法是反向传播算法。在该算法中,根据损失函数相对于给定参数的梯度来调整参数(模型权重)。 为了计算这些梯度,PyTorch有一个内置…...

创建型模式之 Builder (生成器)
创建型模式之 Builder (生成器) 摘要: 本文介绍了生成器(Builder)设计模式,属于创建型模式之一。该模式通过将复杂对象的构建与表示分离,使同一构建过程能创建不同表现形式。文章以小米汽车不同配置版本为例说明了模式…...

智能物资出入库管控系统
概述 智能物资管理系统利用RFID自动识别技术,物联网技术、人脸识别、指纹、指静脉生物识别技术,应用于军械装备的管理,可实时准确采集军械装备编配、 储存、供应、使用等数据,实时掌握军械装备物资的分布及数量 状况。细化管理到…...
鸿蒙OSUniApp 制作倒计时与提醒功能#三方框架 #Uniapp
使用 UniApp 制作倒计时与提醒功能 前言 倒计时与提醒功能在移动应用中应用广泛,如活动秒杀、任务提醒、考试倒计时等。一个实用的倒计时组件不仅要精准计时,还要兼容多端,尤其是在鸿蒙(HarmonyOS)等新兴平台上保证流…...
深入剖析网络协议:七层协议与四层协议详解
在计算机网络的世界中,数据的传输与交互离不开协议的规范。其中,七层协议和四层协议是网络通信架构的核心概念,它们如同网络世界的 “交通规则”,保障着数据准确、高效地在不同设备间流转。本文将深入解读七层协议与四层协议&…...

机器学习-线性回归基础
一、什么是回归 依据输入x写出一个目标值y的计算方程,求回归系数的过程就叫回归。简言之:根据题意列出方程,求出系数的过程就叫做回归。 回归的目的是预测数值型的目标值y,分类的目的预测标称型的目标值y。 二、线性回归 2.1线性…...
自学嵌入式 day 25 - 系统编程 标准io 缓冲区 文件io
(3)二进制文件读写函数: ①fread: size_t fread(void *ptr, size_t size, size_t nmemb, FILE *stream); 功能:从指定的stream流对象中获取nmemeb个大小为size字节的数据块到ptr所在的本地内存中。 参数&…...

[Vue组件]半环进度显示器
[Vue组件]半环进度显示器 纯svg实现,不需要其他第三方库,功能简单,理论上现代浏览器都能支持 封装组件 所有参数都选填,进度都可选填 <template><div class"ys-semiring"><div class"svg-container…...

科技赋能建筑行业,智能楼宇自控系统崭露头角成发展新势力
在科技浪潮席卷全球的时代背景下,传统建筑行业正面临着前所未有的变革压力。随着城市化进程加快,建筑规模与复杂度不断攀升,能源消耗、运营效率、用户体验等问题日益凸显。智能楼宇自控系统凭借物联网、大数据、人工智能等前沿技术࿰…...
Rust入门之并发编程基础(一)
Rust入门之并发编程基础(一) 无畏并发 本文源码 安全且高效地处理并发编程是 Rust 的另一个主要目标。并发编程(Concurrent programming),代表程序的不同部分相互独立地执行,而 并行编程(par…...
高级特性实战:死信队列、延迟队列与优先级队列(二)
三、延迟队列:实现任务定时执行 3.1 延迟队列概念解析 延迟队列(Delay Queue),是一种特殊的队列,它的独特之处在于队列中的元素(消息)并不会立即被处理,而是会在指定的延迟时间过后…...
VR 电缆故障测试系统:技术革新
VR 电缆故障测试系统,作为电力领域的创新科技成果,融合了虚拟现实技术、三维建模、实时交互等前沿技术,为电缆故障测试带来了全新的解决方案。它的工作原理犹如一位经验丰富的侦探,通过层层线索,精准地锁定电缆故障的位…...
Rocky Linux上安装Go
使用官方二进制包安装 1. 下载 Go 官方二进制包 cd /tmp wget https://go.dev/dl/go1.22.3.linux-amd64.tar.gz2. 解压并安装到 /usr/local sudo rm -rf /usr/local/go # 如果之前有旧版本先删除 sudo tar -C /usr/local -xzf go1.22.3.linux-amd64.tar.gz3. 设置环境变量…...
深度学习论文: FastVLM: Efficient Vision Encoding for Vision Language Models
深度学习论文: FastVLM: Efficient Vision Encoding for Vision Language Models FastVLM: Efficient Vision Encoding for Vision Language Models PDF: https://www.arxiv.org/abs/2412.13303 PyTorch代码: https://github.com/shanglianlm0525/CvPytorch PyTorch代码: https…...

白杨SEO:做AI搜索优化的DeepSeek、豆包、Kimi、百度文心一言、腾讯元宝、通义、智谱、天工等AI生成内容信息采集主要来自哪?占比是多少?
大家好,我是白杨SEO,专注SEO十年以上,全网SEO流量实战派,AI搜索优化研究者。 在开始写之前,先说个抱歉。 上周在上海客户以及线下聚会AI搜索优化分享说各大AI模型的联网搜索是关闭的,最开始上来确实是的。…...

显示docker桌面,vnc远程连接docker
目录 相关概念: 实现步骤: 1.启动docker容器 2.安装x11 3.Docker 容器中安装一个完整的图形桌面(XFCE)和 VNC 远程桌面服务器(TightVNC) 4.配置vncservice 5.本地安装VNC Viewer连接VNC Viewer下载地…...
Web 端顶级视效实现:山海鲸端渲染底层原理与发布模式详解
大家好,欢迎大家回到山海鲸的渲染模式系列教程。昨天,我们看了一下山海鲸支持的3种渲染模式的整体概览。今天,我们就来看一下山海鲸支持的最基础的渲染模式,也就是端渲染的渲染设置。 1. 山海鲸的端渲染 我们说到端渲染…...

腾讯云国际站性能调优
全球化业务扩张中,云端性能直接决定用户体验与商业成败。腾讯云国际站通过资源适配、网络优化与存储革新,为企业提供全链路调优方案。 资源精准适配 实例选型需与业务场景深度耦合,计算优化型实例加速AI训练效率3倍,内存…...

深入解析操作系统内核与用户空间以及内核态与用户态转换
用户空间和内核空间的划分是现代操作系统的基础,对应用程序网络模型的设计和优化有着深远的影响。 内核空间与用户空间的分工 现代操作系统为了保证系统的稳定性和安全性,将虚拟内存空间划分为用户空间和内核空间。 一、用户空间 用户空间是用户程序…...

每日一题洛谷P8662 [蓝桥杯 2018 省 AB] 全球变暖c++
P8662 [蓝桥杯 2018 省 AB] 全球变暖 - 洛谷 (luogu.com.cn) DFS #include<iostream> using namespace std; int n, res; char a[1005][1005]; bool vis[1005][1005]; bool flag; int dx[4] { 0,0,1,-1 }; int dy[4] { 1,-1,0,0 }; void dfs(int x, int y) {vis[x][y]…...

【JVM】初识JVM 从字节码文件到类的生命周期
初识JVM JVM(Java Virtual Machine)即 Java 虚拟机,是 Java 技术的核心组件之一。JVM的本质就是运行在计算机上的一个程序,通过软件模拟实现了一台抽象的计算机的功能。JVM是Java程序的运行环境,负责加载字节码文件&a…...

多级体验体系构建:基于开源AI智能客服与AI智能名片的S2B2C商城小程序体验升级路径研究
摘要:在体验经济时代,传统企业单一的总部体验模式难以覆盖全链路用户需求。本文针对B端与C端体验深度差异,提出“一级总部体验—二级区域体验—三级终端体验”的分层架构,并引入“开源AI智能客服”与“AI智能名片”技术࿰…...
每日算法 -【Swift 算法】字符串转整数算法题详解:myAtoi 实现与正则表达式对比
Swift 字符串转整数算法题详解:myAtoi 实现与正则表达式对比 🧩 题目背景 LeetCode 上的经典算法题 8. String to Integer (atoi) 是一道考察字符串解析与边界处理的题目。这道题虽看似简单,但处理细节相当复杂。我们将使用 Swift 语言实现…...