首页 > 其他分享 >Gitlab分支管理规范和提交代码规范

Gitlab分支管理规范和提交代码规范

时间:2024-09-27 16:13:54浏览次数:10  
标签:-- 代码 Gitlab 规范 merge 提交 main 分支

  • gitlab分支管理规范
    分支说明:
    测试代码库共有三个分支,main分支、dev分支、release分支
    -- main分支:存放运行稳定的最新代码 ,一般不直接将未审核的代码合入到main分支
    -- dev分支:存放个人开发的用例脚本,可用于用例故障修复,新的用例开发等
    -- release分支:对应上线的产品版本,在发布上线产品时,同步从main分支拉取得到该release分支
    分支merge说明:
    -- dev分支用例代码开发完成并执行成功后,从各自的dev分支merge到main分支
    -- merge request过程中需要注意将assignee和reviewer指派为同组内其它小伙伴,待审核通过后即可merge到main分支
    -- merge前一定要确保分支代码是最新的,避免删减或修改掉其他小伙伴的代码
    -- merge发起人负责解决代码合并过程中出现的conflict

  • gitlab提交代码规范
    1.使用分支和合并策略 a. 使用分支:每个新功能或修复应当在单独的分支上进行开发,分支命令规范,例:hel-dev。 b. 合并前测试:在合并代码到主分支之前,确保所有提交的py文件在本地运行都通过后再提交。 c. 代码审查:合并之前,应当经过代码审查(Code Review),以确保代码质量和一致性。
    2.提交信息规范,commit信息应当简洁明了,包含以下几个部分: a. 简短的标题:简要描述本次提交的内容。 b. 详细描述:对提交内容进行详细说明,必要时包含上下文信息。 c. 问题追踪:如修复或更改因项目接口更新而导致的问题。 例: 添加用户登录接口的自动化测试脚本
    o增加了 login_test.py 文件
    o添加了基本的登录接口测试用例,包括成功登录和失败登录的测试
    o更新了 README 文件,增加了接口测试的说明
    3.提交频率和粒度 a. 单一目的:每次提交应当专注于单一目的或任务,如添加一个新功能、修复一个 bug 或重构代码。 b. 小而频繁:提交应当保持小而频繁(如新增了一个接口的用例或修改了多个接口的用例,单次提交不超过3个py文件),这样可以更容易地追踪更改并减少冲突。(但要避免过度提交,例如:修改注释)
    4.代码风格和格式化 a. 遵循代码风格指南:例如,PEP 8 是 Python 代码的风格指南。确保代码符合团队约定的风格指南。参见:https://alidocs.dingtalk.com/i/nodes/gwva2dxOW4Kpd4egs6A4ZBQm8bkz3BRL?corpId=ding83b4c2160bab5111&doc_type=wiki_doc&iframeQuery=utm_source%3Dportal%26utm_medium%3Dportal_new_tab_open&rnd=0.8090448653335316&sideCollapsed=true&utm_scene=team_space b. 代码格式化:若使用pycharm可使用shirt+ctrl+alt+L来格式化代码;或使用如 black、flake8 或 pylint 等工具来自动格式化代码和检查代码质量。
    5.代码注释 a. 代码文档化:在提交代码时,确保代码有适当的注释和文档。特别是对于复杂的逻辑和关键的接口。 b. 更新相关文档:如果提交的更改影响了项目的文档,如 README 或接口文档,确保同步更新这些文档。
    6.避免提交敏感信息 a. 确保不将敏感信息提交到版本控制系统中(例如:本项目的数据库连接密码)

标签:--,代码,Gitlab,规范,merge,提交,main,分支
From: https://www.cnblogs.com/helStrive/p/18435962

相关文章

  • pbootcms提示“提交失败,请使用POST方式提交”
    当你将在线留言栏目的URL名称设置为message时,这个名称与PbootCMS系统的保留关键字冲突。PbootCMS系统会默认执行与message相关的控制器,而不是你期望的在线留言表单提交逻辑。PbootCMS系统的保留关键字PbootCMS系统中有一些保留关键字,这些关键字不能用作URL名称。以下是常见的保......
  • 查看文件的提交记录
    文件提交记录查看文件的历史提交记录如果我们想查看某个文件的历史提交记录可以用gitlog--oneline<file>TGL@TGLMINGW64~/Desktop/TH-ISE130-I/feature(feature)$gitlog--onelineProject/04_ADC/adc.c82c2cd7(HEAD->feature)2024年09月13日17:01:518a33007......
  • git eslint扩展,解决git提交因为空格差异而报错
    项目场景:在前端项目开发中,经常会使用eslint,这个方法的好处就是严格要求代码格式。让代码更为严谨。问题描述以为eslint格式过于严谨,在git提交的时候,经常会因为一个多了一个空格导致代码提交失败。原因分析:eslint严格要求代码风格,导致稍微有一点不一致,就会报错,是git代码......
  • pbootcms提示:登录失败:表单提交校验失败,请刷新后重试!
    当使用PBootCMS后台登录时遇到“登录失败:表单提交校验失败,请刷新后重试!”的错误提示时,这通常是由于一些配置或环境问题导致的。以下是一些常见的解决方法:常见解决方法删除 runtime 目录切换PHP版本清除浏览器缓存检查CSRF令牌解决方法详细步骤方法一:删除 runtime......
  • GitLab 中文发行版最新的 17.4 发布了哪些与代码托管、CI/CD、安全合规相关的功能?
    沿袭我们的月度发布传统,极狐GitLab发布了17.4版本,该版本带来了当所有检查通过就会自动合并、WebIDE中的扩展市场现已可用以及获取Kubernetes资源事件等几十个重点功能的改进。下面是部分重点功能的详细解读。极狐GitLab为GitLab的中文发行版,中文版本对国内用户更友好、......
  • 手册和规范:掌握 JavaScript 指南
    欢迎回到我们的JavaScript世界之旅!在这篇博文中,我们将深入探讨有助于您理解和掌握JavaScript的基本手册和规范。无论您是初学者还是经验丰富的开发人员,这些资源都将作为您学习和故障排除的首选参考。让我们探索官方ECMAScript规范、MDNWeb文档和其他有用的资源。官......
  • GitLab 中文版如何升级到最新的 17.4?
    本文分享极狐GitLab17.4升级的详细步骤。今日,极狐GitLab17.4正式发布。新版本发布了几十项与DevSecOps相关的更新,包括项目管理、源代码托管、CI/CD、安全合规等。对于用户来讲及时升级到最新版本不仅能够第一时间体验到最新功能,更重要的是能够避免老旧版本存在的安全风险而遭......
  • centos7安装gitlab并汉化
    一、基础环境准备1.安装依赖包[root@gitlab-server~]#yuminstallcurlpolicycoreutilsopenssh-serveropenssh-clientspostfixwgetgitpatch-y[root@gitlab-server~]#systemctlstartpostfix2.配置yum源(由于网络问题,国内用户,建议使用清华大学的镜像源进行安装)[root@g......
  • git修改某些指定提交的履历信息
    一,关于gitrebase-ihead~n的命令,可以修改某个提交的提交履历1,gitlog查看提交log,确认需要修改的commit2,gitrebase-ihead~2(以修改最后的两次提交的履历为例)3,进入gitvim编辑页面,按键盘i进入编辑模式,将需要修改履历的两条提交的“pick”改为“r”(此时不需要改履历信息)4,按......
  • 测试开发(自动化测试规范)-第二章
    1.1.1.数据层业务中不要写入任何硬编码数据,其来源均来自于数据层的提供l输入数据不管哪种类型数据都是传入的数据对象,不传具体的构造、实现有四种输入数据--参数化数据参数化数据可为UI自动化提供数据输入,可支持不同类型的数据excel、csv、xml、yaml--整体数据驱动数......