精华内容
下载资源
问答
  • 这个插件就是规范git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范 这个提交记录是不是...
  • git 规范

    2021-07-02 10:51:03
    Git规范 Git推送与合作规范 一、规范简述 为了更好的完成代码版本管理以及多人合作,必须统一Git的推送规范以及一些代码合作上的规范 二、Git代码提交规范 除了项目初始化的时候,禁止使用[git add .]进行修改提交。...

    Git规范
    Git推送与合作规范

    一、规范简述

    为了更好的完成代码版本管理以及多人合作,必须统一Git的推送规范以及一些代码合作上的规范

    二、Git代码提交规范

    除了项目初始化的时候,禁止使用[git add .]进行修改提交。
    代码提交尽量按照单次编写的功能模块进行整体提交。
    例如A和B两个文件都是改的登录相关的内容,C文件改的为用户中心相关的内容,那么应分两次进行[git add]以及[git commit]。
    若是使用编辑器,则可以用编辑器自带的Git模块进行单文件的提交。

         git add A
         git add B
         git commit -m "[功能]登录模块功能开发"
         git add C
         git commit -m "[更新]个人中心头像模块更新"
         git push
    

    在无分支的开发情况下,禁止使用merge进行代码合并

    三、Git提交时的说明规范
    说明Tag名 使用场景

         [功能]	当新提交功能模块时使用此标签
         [更新]	当对功能模块阶段性开发更新时使用此标签
         [修复]	当对功能模块的Bug进行修复时使用此标签
    
    展开全文
  • git规范

    2020-09-19 16:58:21
  • git规范与日志规范

    千次阅读 2019-08-01 14:16:37
    因为要分享git规范,所以今天也顺便做一个总结,这个仅限于对git的开发中和部署时的规范和提交时的日志规范做总结。本文章分两个部分总结git规范,一个是从分支讲解在开发 目录 分支构成 永久分支-master,develop ...

    因为要分享git规范,所以今天也顺便做一个总结,这个仅限于对git的开发中和部署时的规范和提交时的日志规范做总结。本文章分两个部分总结git规范,一个是从分支讲解在开发

    目录

    • 分支构成
      • 永久分支-master,develop
      • Feature
      • Hotfix
      • 补充(特殊情况下处理方式)
    • git提交规范-commit message
      • Header
      • Type
      • Scope
      • Subject
      • Body
      • Footer
      • Revert
        看这个规范之前需要知道了解一些基本的git操作命令

    分支构成

    master和develop分支一直存在,且名称不会变化,一般不直接修改这2个分支,由其他分支合并而来。

    feature、release、hotfix分别用于功能点开发、优化,特定版本测试,线上问题紧急处理,同一类型的分支会产生多个。

    分支划分如下:

    • master:与线上版本保持绝对一致;
    • develop:开发分支,由下文提到的release、feature、hotfix分支合并过后的代码;
    • feature:实际功能点开发分支,建议每个功能新建一个feature, 具有关联关系的功能公用一个feature分支;
    • release:每一次开发完成之后,从develop创建出来的分支,以此分支为基准,进行测试;
    • hotfix:该分支主要用于修复线上bug;

    命名规范约定如下:

    • feature分支命名:feature/name
    • release分支命名:release/name
    • hotfix分支命名:hotfix/name

    比如有一个「优化分布式Session」的需求,可在develop分支的基础上创建新分支 feature/optimize_distributed_session进行开发,开发完成后合并到develop分支。

    分支详细介绍和处理流程

    1 永久分支:Master分支与Develop分支
    在这里插入图片描述

    • Master分支上的Commit都有对应的Tag。
    • Develop分支与Master分支是两个永久存在的分支,从公Master拉取Develop分支。
    • Develop分支不直接合并到Master分支,其通过Release分支合并到Master分支。
    • Master分支与线上版本保持一致。
    • Develop分支是自动构建分支,它总是保有当前即将发布或是已经发布的代码,是确定的下一次将要通过Release分支合并到master上的代码。
    解说: 
    

    主分支,与线上运行的版本始终保持一致,任何时候都不要直接修改master分支。一个版本的release分支、hotfix分支开发完成后,会合并代码到master分支,也就是说master分支主要来源于release分支和hotfix分支。
    开发分支,始终保持最新完成以及bug修复后的代码,新增功能时基于该分支创建feature分支。一个版本的release分支、hotfix分支开发完成后,也会合并到develop分支,另外,一个版本的feature功能开发完成后,也会合并到develop分支。也就是说develop分支来源于feature、release、hotfix分支。

    Feature 分支
    分支名 feature/*
    Feature分支做完后,必须合并回Develop分支, 合并完分支后一般会删点这个Feature分支,但是我们也可以保留
    在这里插入图片描述解说
    开发新功能或优化现有功能时,会创建feature分支,以develop为基础创建。一般会有多个功能同时开发,但上线时间可能不同,在适当的时候将特定的feature分支合并到develop分支,并创建release分支,进入测试状态。

    Release分支

    分支名 release/*

    Release分支基于Develop分支创建,打完Release分之后,我们可以在这个Release分支上测试,修改Bug等。同时,其它开发人员可以基于开发新的Feature (记住:一旦打了Release分支之后不要从Develop分支上合并新的改动到Release分支)
    发布Release分支时,合并Release到Master和Develop, 同时在Master分支上打个Tag记住Release版本号,然后可以删除Release分支了。
    在这里插入图片描述解说:
    当一组feature开发完成,会首先合并到develop分支,开始进入提测阶段时,会创建release分支。以release分支代码为基准提测,测试过程中若存在bug需要修复,则直接由开发者在release分支修复并提交。测试完成之后,合并release分支到master和develop分支,此时master为最新代码,用作上线。

    维护分支 Hotfix

    分支名 hotfix/*

    hotfix分支基于Master分支创建,开发完后需要合并回Master和Develop分支,同时在Master上打一个tag
    在这里插入图片描述解说:
    线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支,修复完成后,需要合并到master分支和develop分支。

    特殊情况

    1. develop分支已存在未上线的feature代码, 此时需要紧急上线一个新功能, 但develop的代码不能上,如何处理 ?
      • 以master为基线创建feature, 在完成之后,代码合并到master分支;
      • 为了保证develop是最新代码,需要从master合并到develop分支;
    2. 以develop为基线,创建了f1和f2两个feature分支之后, f1,f2开发一半的时候,发现两个分支代码需要有依赖怎么办 ?
      • 最好在开发开始前确定两个功能是否相关,若相关则只创建一个分支,两个功能在一起开发;
      • 如果已经创建,则需要合并到一个分支;
      注意: 一定要保证commit历史记录的整洁,代码合并时,根据情况选择merge或rebase;使用rebase注意,一旦分支中的提交对象发布到公共仓库,就千万不要对该分支进行衍合操作;

    git提交规范-commit message

    Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。
    使用Angular的Commit message 格式。也有配套的工具(自行选择)
    https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits

    $ git commit -m "hello world"
    

    上面代码的-m参数,就是用来指定 commit mesage 的。
    如果一行不够,可以只执行git commit,就会跳出文本编辑器,让你写多行。
    一般来说,commit message 应该清晰明了,说明本次提交的目的。
    Git上随便打开一个git的源码,比如spring boot的就可以看到那些提交记录

    commit message 格式

    每个commit message 包括header,body和footer,各占一行。其中header由type、scope和subject组成。header必须要写,header的scope是可选的。Body 和 Footer 也以省略。

    <type>(<scope>): <subject>
    //空一行
    <body>
    //空一行
     <footer>
    

    每行不超过100字符也有72个的,原因,为了美观

    Header

    Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

    Type

    必须为下列之一:
    • feat:新功能(feature)
    • fix:修补bug
    • docs:文档修改
    • style: 不影响代码含义的修改(例如:white-space; 格式化等)
    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    • perf: 提升性能的修改
    • test:增加或修改测试
    • chore:构建流程或辅助工具的变动

    Scope

    scope用于说明commit修改的范围,比如数据层、控制层、视图层,route, component, utils, build等等。如果修改影响多处,可使用"*"。

    Subject

    Subject是对修改的简要说明:
    • 使用祈使语气,一般现在时。
    • 首字母小写
    • 句末不要使用句号

    Body

    使用祈使语气,一般现在时。另外,body需要包含修改的原因和与之前版本的区别。

    Footer

    任何Breaking changes的信息或者关闭issue的信息都可写在Footer. Breaking changes需要以 BREAKING CHANGE: 开头。
    如下为我的2条提交记录:

    commit 9fb447d73c637cfa128b57a84d95dc72bb14412b (HEAD -> master)
    Author: zhongjx <amy_zhjx@163.com>
    Date:   Wed Dec 26 18:22:53 2018 +0800
    
        refactor(*): 使用prettier格式化代码
        
        使用eslint+prettier取代之前的eslint+airbnb规范
    
    commit a4a5e9259d5dd4f5f4d3d16fea3392df2a877ee1 (origin/master)
    Author: zhongjx <amy_zhjx@163.com>
    Date:   Tue Nov 20 09:49:27 2018 +0800
    
        chore: 添加commit msg格式要求
    
    

    Revert
    如果commit用于撤销之前的commit,需以revert:开头,接着写被撤销的commit的header。body里要写:this reverts commit . hash为被撤销的commit的hash值。这种格式也可以由git revert命令自动生成。

    展开全文
  • 内容我们整理总结了关于PHP代码规范、流程规范、git规范的详细内容,对此有兴趣的朋友可以学习下。
  • git规范细则

    2020-09-16 21:04:48
    git规范细则

    git规范细则


    对于Git的提交日志,我们有非常明确而详细的提交规范。这将有助于我们在查看 项目历史时, 更容易明确每一次提交的内容。

    提交消息格式

    每个提交消息都由一个标题、一个正文和一个页脚组成。而标题又具有特殊格式,包括修改类型、影响范围和内容主题:

    修改类型(影响范围): 标题
    <--空行-->
    [正文]
    <--空行-->
    [页脚]
    

    标题是强制性的,但标题的范围是可选的

    提交消息的任何一行都不能超过100个字符!这是为了让消息在GitHub以及各种Git工具中都更容易阅读。

    修改类型

    每个类型值都表示了不同的含义,类型值必须是以下的其中一个:

    • feat: 提交新功能
    • fix:修复了bug
    • docs:只修改了文档
    • style:调整代码格式,未修改代码逻辑(比如修改空格、格式化、缺少分号等)
    • refactor:代码重构,既没修复bug也没有添加新功能
    • perf:性能优化,提高性能的代码更改
    • test:添加或修改代码测试
    • chore:对构建流程或辅助工具和依赖库(如文档生成等)的更改

    代码回滚

    代码回滚比较特殊,如果本次提交是为了恢复到之前的某个提交,那提交消息应该以“revert:”开头,后跟要恢复到的那个提交的标题。然后在消息正文中,应该写上“This reverts commit ”,其中“”是要还原的那个提交的SHA值。

    影响范围

    范围不是固定值,它可以是你提交代码实际影响到的任何内容。例如 l o c a t i o n 、 location、 locationbrowser、 c o m p i l e 、 compile、 compilerootScope、ngHref、ngClick、ngView等,唯一需要注意的是它必须足够简短。

    当修改影响多个范围时,也可以使用“*”。

    标题

    标题是对变更的简明描述:

    • 使用祈使句,现在时态:是“change”不是“changed”也不是“changes”
    • 不要大写首字母
    • 结尾不要使用句号

    正文

    正文是对标题的补充,但它不是必须的。和标题一样,它也要求使用祈使句且现在时态,正文应该包含更详细的信息,如代码修改的动机,与修改前的代码对比等。

    页脚

    任何Breaking Changes(破坏性变更,不向下兼容) 都应该在页脚中进行说明,它经常也用来引用本次提交解决的GitHub Issue

    Breaking Changes应该以“BREAKING CHANGE:”开头,然后紧跟一个空格或两个换行符,其他要求与前面一致。

    git 使用流程规范(merge-request)

    如今很多项目都采取merge request方式来进行codereview,所有掌握merge request很有必要,步骤如下:
    1.现在本地用创建一个本地分支,比如叫xx_branch。
    2.改动xx_branch你需要改动的代码。
    3.进入你的项目根目录下,运行如下命令,将xx_branch推到远程分支。
    git add .
    git commit -a -m ‘xxxxx’
    git push -u origin xx_branch
    4.在gitlab上面操作,进入xx项目下,点击merge request选项,然后选择你之前推到远端的xx_branch和你要合并到哪个分支,比如你要合并到master上。
    5.点击merge request。

    git解决冲突

    1. git stash 
    2. git pull
    3. git stash pop
    4. 解决冲突
    5. git pull
    

    代码合并

    1.单分支合并

    git stash 
    git pull
    git stash pop
    # 合并冲突并进行提交
    git push
    

    2.多分支合并

    # 将my_feature合并到develop
    git clone -b my_feature ***
    git checkout -b develop
    # 将本地的develop追踪远程的develop
    git branch --set-upstream-to=origin/develop develop
    git pull
    # 合并解决冲突,进行提交
    git push
    
    展开全文
  • 日活千万级公司git使用规格。 目的 1 开发人员 git 使用流程(规范) 2 提交规范 2 分支建立规范 4 新功能开发分支建立规范 4 发布规范 4
  • 关于git项目管理分支说明。 2.1. master主干 命名:master 说明:发布分支 master为程序主干目录,开发新需求需从master打新分支,开发完成合并回master发测试包,测试完成需打新的tag包,tag包申请上线发布 2.2. ...
  • git提交代码注释规范

    2018-01-12 16:24:01
    git提交代码注释规范git提交常用操作的规范指南、[A] 新增 :(新加入的需求) [M] 修改 :( 修改或者重构代码) [D] 删除 :(删除多余的文件 ) [F] 修复 :(修复bug)
  • git 规范操作

    2019-08-16 16:37:16
    1.git clone 从server上clone一份代码到本地,经常指定分支 git clone -b <branch> git@xxxx.git 2. 默认的branch,就是指定的那个-b后面的branch,创建一个新的branch git checkout -b mydev 3.修改需要...
  • Git规范

    2016-04-06 09:30:39
    Git规范by 程序亦非猿 2016.4.6这又是一篇我在公司分享的,想制定一下Git的规范,有兴趣的可以看看~上一篇在这里分支模型每个项目必须要有master、deve...
  • Git规范化工作流程

    2018-07-10 18:53:12
    (本文已发表至微信公众号:CGRnDStudio,该公众号...本文简单介绍了Git规范化工作流程及常用Git命令克隆项目,新建分支# clone项目到本地,新建分支 git clone &lt;URL&gt; # 仅克隆指定分支,不会有其他...
  • git提交代码常用规范

    2020-12-30 17:56:33
    git提交代码常用规范
  • git版本管理规范

    2018-01-16 14:10:45
    git版本管理规范,gitlab开发工具,git版本管理
  • Git 是目前最流行的源代码管理工具。为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关操作
  • git提交规范

    千次阅读 2019-02-22 09:16:42
    &amp;gt; 其中 type 的值可以有很多,下面有几个我们常用到的 . feat :新功能 . fix :修复bug . doc : 文档改变 . style : 代码格式改变 . refactor :某个已有功能重构 ... .... ...
  • Git 使用规范流程

    2019-08-14 19:32:55
    有效使用Git,遵循一个合理、清晰的Git使用流程,非常重要。 第一步:新建分支 每次开发新功能,都应该新建一个单独的分支。 # 获取主干最新代码 git checkout master git pull # 新建一个开发分支myfeature git ...
  • Git使用规范

    千次阅读 2018-05-18 17:12:55
    Git使用规范 本人在实际工作中总结出的Git使用规范,比较简单,容易落地。 1. 分制管理 开发过程主要存在以下分支: master dev hotfix-[问题名称 | bug编号] feature-[功能名称] bugfix-[bug编号] refactor...
  • 一篇文章搞定Git——Git代码管理及使用规范

    万次阅读 多人点赞 2019-05-22 17:55:25
    no changes added to commit (use "git add" and/or "git commit -a") 在你解决了所有文件里的冲突之后,对每个文件使用git add命令来将其标记为冲突已解决。 一旦暂存这些原本有冲突的文件,Git 就会将它们标记...
  • git规范提交

    2021-10-19 14:19:39
    git不规范的提交 git commit -m “description” 使用不规范的提交会导致出错。 subject may not be empty [subject-empty] git规范提交 git commit -m “feat: description”
  • 点击“开发者技术前线”,选择“星标????”让一部分开发者看到未来回复“666”,获取一份技术人专属大礼包转自公众号:腾讯技术工程"因为不怎么会Git,自己平时合代码老出错,最...
  • java代码格式规范 参考阿里java代码规范 Pull Request要求 代码格式 提交前请按项目风格进行格式化。 必须添加测试! - 提交前必须确认代码可运行。 记得更新文档 - 保证README.md以及其他相关文档及时更新,和...
  • git 规范化提交代码结合tag自动生成log日志 git commit 信息提交规范含义- feat : 新功能- fix : 修复bug- docs : 文档改变- style : 样式改变-不影响代码含义的更改(空白、格式、缺少分号)- refactor : 重构-不...
  • 如何规范你的Git commit?

    千次阅读 2020-08-13 11:32:55
    本文分享在git commit规范建设上的实践,规定了commit message的格式,并通过webhook在提交时进行监控,避免不规范的代码提交。背景Git每次提交代码都需要写commit message,否则就不允许提交。一般来说,commit ...
  • 官方解释:Git(读音为/gɪt/。)是一个开源的分布式版本控制系统,可以有效、高速地处理从很小到非常大的项目版本管理。 Git 是 [Linus Torvalds](https://baike.baidu.com/item/Linus Torvalds/9336769) 为了帮助...
  • Git 注释规范

    千次阅读 2019-06-05 14:43:27
    使用第一人称现在时,比如change,而不是changed或changes 第一个字母小写 结尾不加句号(.) (可选) 部分是对本次 commit 的详细描述,可以分成多行 优化自:https://www.jianshu.com/p/79454cf00945 Git Commit ...
  • Git提交说明规范

    2021-04-14 17:08:32
    规范介绍 git commit信息格式介绍 type(scope): subject type(必须): commit 的类别,只允许使用下面几个标识: feat: 新的功能, fix: 修复Bug, docs: 只有文档变更, style: 空格, 分号等格式修复, refactor: ...
  • Git提交信息规范

    万次阅读 多人点赞 2018-05-11 17:52:07
    目的 统一团队Git Commit标准,便于后续代码review、版本发布、自动化生成change log;...Git版本规范 分支 master分支为主分支(保护分支),不能直接在master上进行修改代码和提交; develo...
  • 为了规范化团队代码提交,可以对git提交规范进行一定的约束 方便后期管理维护 1.首先第一步 在file-settings-plugins marketplace中搜索插件git commit template 2.第二步 提交时

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 61,984
精华内容 24,793
关键字:

git规范