前端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流程
相关文章
|
3天前
|
人工智能 缓存 开发工具
结合企业实践来规范你的Git commit(含插件使用指南)
结合企业实践来规范你的Git commit(含插件使用指南)
结合企业实践来规范你的Git commit(含插件使用指南)
|
3天前
|
缓存 前端开发
前端代码整洁与规范之CSS篇
【4月更文挑战第2天】 前端代码整洁与规范之CSS篇
50 4
|
3天前
|
存储 前端开发 开发工具
前端开发中的Git版本控制:构建可靠的协作和代码管理
前端开发中的Git版本控制:构建可靠的协作和代码管理
51 0
|
3天前
|
前端开发
【Web前端】CSS基本语法规范和引入方式&&常见选择器用法&&常见元素属性
【Web前端】CSS基本语法规范和引入方式&&常见选择器用法&&常见元素属性
|
3天前
|
前端开发 持续交付 开发工具
【专栏:工具与技巧篇】版本控制与Git在前端开发中的应用
【4月更文挑战第30天】Git是前端开发中的必备工具,它通过分布式版本控制管理代码历史,支持分支、合并、回滚等操作,促进团队协作和冲突解决。在前端项目中,Git用于代码追踪、代码审查、持续集成与部署,提升效率和质量。优化协作包括制定分支策略、编写清晰提交信息、定期合并清理分支及使用Git钩子和自动化工具。掌握Git能有效提升开发效率和代码质量。
|
3天前
|
前端开发 数据安全/隐私保护
开发指南016-前端图标规范
平台为了保证统一性,做了很多约定,例如按钮图标等
|
3天前
|
前端开发 JavaScript 算法
比较流行的前端代码书写规范都有哪些
【4月更文挑战第13天】前端代码规范增进代码可读性和团队协作,包括缩进(用2空格)、命名(变量 camelCase,常量 MY_CONSTANT,类 PascalCase)、注释、语句与表达式、错误处理、代码复用。文件命名规范涉及扩展名、目录结构、简洁文件名、入口文件和配置文件命名。遵循这些规范能提高代码一致性,但需按项目需求调整。不断学习新规范以适应前端技术发展。
20 1
|
3天前
|
弹性计算 开发工具 git
如何创建符合计算巢规范的Git仓库
为了简化软件云化部署,阿里云计算巢提供了一站式平台,开发者仅需将自己的git仓库配置为符合计算巢服务规范,即可实现自动化部署到云端。官方提供了多个模板,涵盖不同架构和部署物类型,便于开发者从计算巢官方仓库fork并定制。重要文件包含config.yaml和,用于配置服务构建参数。通过计算巢控制台,即可完成服务的创建和发布,实现软件的云上部署。
|
3天前
|
前端开发
前端模块化开发规范
前端模块化开发规范
|
3天前
|
人工智能 自然语言处理 前端开发
前端训练不规范导致AIGC模型“上梁不正”
【1月更文挑战第23天】前端训练不规范导致AIGC模型“上梁不正”
43 1
前端训练不规范导致AIGC模型“上梁不正”