前端Git规范

简介: 前端Git规范

日志规范

在一个团队协作的项目中,开发人员需要经常提交一些代码去修复bug或者实现新的feature。而项目中的文件和实现什么功能、解决什么问题都会渐渐淡忘,最后需要浪费时间去阅读代码。但是好的日志规范commit messages编写有帮助到我们,它也反映了一个开发人员是否是良好的协作者

规则

1、feature分支pr进develop时,需简介feature功能;

2、dev分支pr进demo及master时,需按需求进行相关审核;

2、feature子分支合并进feature时,需简介模块功能;

4、分支的commit内容描述一下提交内容;

5、feature子分支在用过之后,确认功能完善,代码提测完成后,将远程仓库删除,保持仓库整洁。

Commit规范:

类型 含义
 <feat>  新增功能
 <fix>  修复bug
 <docs>  仅仅修改了文档,比如README/CHANGELOG/CONTRIBUTE等
 <style>  仅仅修改了空格、格式缩进、偏好等信息,不改变代码逻辑
 <refactor>  代码重构,没有新增功能或修复bug
 <perf>  优化相关,提升了性能和体验
 <test>  测试用例,包括单元测试和集成测试
 <chore>  改变构建流程,或者添加了依赖库和工具
 <revert>  回滚到上一个版本
 <ci>  CI配置,脚本文件更新等

(必须写)<type>(<scope>):<subject/>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

积压工作项顶格写在 type之前 例如:git commit -m '#积压工作项数字 feat: 新增xx功能'

分支管理

git流程:

itemContent.png

分支类型 命名 分支名称 含义
 <Master>  master 生产分支 master分支唯一且稳定,一般修复bug后,确保稳定才合并到master分支
 <Develop>  dev 开发分支 dev分支唯一,feature分支开发依赖于dev分支,测试开发环境依赖分支
 <Feature>  feature-团队名称简写 功能子分支 每个外协团队单独一个分支,外协团队前端成员都在本feature同一分支中进行单线的git开发操作,在每个分支里写代码业务逻辑,完成之后合并到dev分支;分支名可按“feature-团队名简写”命名,如:“feature-zy”
 <Feature>  feature-团队名称简写 功能子分支 每个外协团队单独一个分支,外协团队前端成员都在本feature同一分支中进行单线的git开发操作,在每个分支里写代码业务逻辑,完成之后合并到dev分支;分支名可按“feature-团队名简写”命名,如:“feature-hx”

master分支

  • master 为主分支,也是用于部署生产环境的分支,确保master分支稳定性
  • master 分支一般由develop分支合并,任何时间都不能直接修改代码

dev 分支

  • dev 为开发分支,始终保持最新完成以及bug修复后的代码,也是用于部署测试开发环境的分支
  • feature子分支是基于dev分支下创建的

feature子分支

  • 分支命名: feature-团队名称简写 命名, 命名规则: feature-zy、feature-hx

常见任务

增加新功能

(dev)$: git checkout -b feature-zy  origin dev          # 从dev建立feature子分支,分支命名为:feature-zy 命名
(feature-zy$: blabla                         # 开发
(feature-zy)$: git pull origin feature-zy                  # 先同步远程git分支,避免分支中的自动merge操作
(feature-zy)$: git add xxx
(feature-zy)$: git commit -m 'commit comment'
(feature-zy)$: git push origin feature-zy    # 推送本地分支到远程仓库
在效能平台建立feature-zy到dev的拉取请求,等待审核后合并,合并后dev分支对应测试开发环境便可进行后续cicd流程
相关文章
|
1月前
|
前端开发 测试技术
如何从零到一建立前端规范
【10月更文挑战第6天】
57 2
|
1月前
|
前端开发 开发工具 git
如何清理 docker 磁盘空间+修改 Gitea 服务器的 Webhook 设置+前端一些好学好用的代码规范-git hook+husky + commitlint
如何清理 docker 磁盘空间+修改 Gitea 服务器的 Webhook 设置+前端一些好学好用的代码规范-git hook+husky + commitlint
33 5
|
3月前
|
前端开发 JavaScript 开发工具
前端规范
前端规范
|
2月前
|
监控 前端开发 开发者
前端代码规范 - 日志打印规范
前端代码规范 - 日志打印规范
|
1月前
|
前端开发 开发工具 git
搭建Registry&Harbor私有仓库、Dockerfile(八)+前端一些好学好用的代码规范-git hook+husky + commitlint
搭建Registry&Harbor私有仓库、Dockerfile(八)+前端一些好学好用的代码规范-git hook+husky + commitlint
19 0
|
3月前
|
消息中间件 小程序 Java
【规范】看看人家Git提交描述,那叫一个规矩
本文通过IDEA中的Git描述规范插件【git commit message helper】,介绍了Git提交描述的规范流程,强调了团队开发中统一标准的重要性,并通过实例展示了规范的提交记录如何提高代码管理和维护效率。最后,文章提供了几个实用的Git提交描述案例,帮助读者更好地理解和应用这些规范。
67 0
【规范】看看人家Git提交描述,那叫一个规矩
|
3月前
|
敏捷开发 小程序 持续交付
【规范】Git分支管理,看看我司是咋整的
本文介绍了Git分支管理规范的重要性及其在企业中的应用。通过规范化的分支管理,可加速团队协作、确保代码质量、维护主分支稳定,并支持敏捷开发。文中详细描述了主分支(如master、develop)和辅助分支(如feature、hotfix)的作用,并提供了实际开发流程示例,包括开发前、开发中、提测、预生产和部署上线等阶段的操作方法。旨在帮助团队提高效率和代码质量。
168 0
【规范】Git分支管理,看看我司是咋整的
|
3月前
|
存储 前端开发 开发工具
前端常用的git操作
【8月更文挑战第24天】前端常用的git操作
18 1
|
3月前
|
JavaScript IDE 前端开发
前端开发工具配置 nodejs & git & IDE
前端开发工具配置 nodejs & git & IDE
|
3月前
|
开发工具 git
Git——commit的提交规范
Git——commit的提交规范
102 4