登录 注册

大家来谈一谈 Git 提交的规范

本贴最后更新于 1615 天前，其中的信息可能已经物是人非

最近要带一批实习生，由于之前本身 Git 提交也不是很规范，这次促使团队需要制定一些代码的规范，目前在编写团队的 Git 代码管理规范，想问一下大家平时都是怎么管理的。

  1. 分支的建立维护
  2. tag 的建立
  3. commit message 的填写格式
    ……

请大家在以上几个方面谈一谈自己平时工作中的做法以及效果。
大家可以畅所欲言，自由扩展其他方面。

  • Git

    Git 是 Linux Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。

    205 引用 • 357 回帖
  • Q&A

    提问之前请先看《提问的智慧》，好的问题比好的答案更有价值。

    6677 引用 • 29939 回帖 • 242 关注
兰州 位置
100 悬赏
6 关注
4 收藏
31 回帖
2
8.1k 295 1.1k 1.2k 2.2k 327 6 724 2.2k

相关帖子

31 回帖
大家来谈一谈 Git 提交的规范

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
  • someone48938 •
    捐赠者

    不只是 commit message 和分支命名规范。我司的代码仓库有 PR 钩子，引入 coverity，对提交的代码用 SonarQube 进行静态分析，不符合代码质量规则的 PR 将无法合并

    截屏 20191219 下午 12.58.12.png

    1 回复
    1 操作
    someone48938 在 2019-12-19 13:45:37 更新了该回帖
  • 其他回帖
  • someone27889 • • 1 • 1 评论
    捐赠者

    因为管理了好多项目,所以这个方面还是研究过一下子 ,主要使用了 GitFlow 规范
    分支分为
    新功能分支(feature),
    修复分支(fix),
    补丁分支(hotfix),
    版本分支(release),
    主分支(master),
    开发分支(dev)

    具体提交格式为

    <type>[optional scope]: <description>

[optional body]

[optional footer]

    * feat 新功能（feature）表示在代码库中新增了一个功能（这和语义化版本中的 [`MINOR`](http://semver.org/#summary) 相对应）
    
* fix 表示在代码库中修复了一个 bug（这和语义化版本中的 [`PATCH`](http://semver.org/#summary) 相对应）
    
* docs 文档（documentation）
    
* style (格式化, 缺失分号等; 不包括生产代码变动)
    
* refactor (重构代码)
    
* perf (性能优化)
    
* test (添加缺失的测试, 重构测试, 不包括生产代码变动)
    
* chore (更新grunt任务等; 不包括生产代码变动)

    scope：一个可选的修改范围，用于标识此次提交主要涉及到代码中哪个模块。

description：简明扼要描述本次提交的内容，首字母无需大写，结尾不需要使用 `.`。

optional body：详细描述本次提交，比如此次变更的动机，如需换行，则使用 `|`。

optional footer：描述与之关联的 issue 或 break change。

    commit Message 为 :

    fix(module:baseuser): fix username field error

BREAKING CHANGE: xxxxxx

    feature(module:auth): add oauth2 module

BREAKING CHANGE: 原登陆方式发生改变,现在提供jar oauth.auth(username,password):true|false

    每次写新特性的时候要在 dev 拉一下最新代码然后 迁出 特性分支 比如要增加一个 用户的新增功能 分支名称可以为 feature/userAdd

    然后开发完了推上去给 dev 分支合并,合并完了跑 ci 测试,ci 测试没问题,可以合并到 master
    当 master 改动较多的时候就可以 发布一个 release 版本 从 master/dev 迁出 然后打 tag ,写 CHANGELOG.md(应该有工具能生成), 发布到 gitlab/github,然后然后然后合并到 master

    资料转自:https://semlinker.com/ng-verson-manage/
    如果多人开发,那么请配置 validate-commit 来确保所有人提交格式符合 GitFlow 规范:https://blog.eiyouhe.com/articles/2019/08/19/1566176660956.html?utm_source=hacpai.com#b3_solo_h1_7
    另外 CHANGELOG 也有 Cli,可以试试:https://blog.eiyouhe.com/articles/2019/08/19/1566176660956.html#b3_solo_h2_12

    所以 100 分给我吧,我求求你了trollface

    3 操作
    someone27889 在 2019-12-18 09:04:50 更新了该回帖
    someone27889 在 2019-12-18 09:03:48 更新了该回帖
    someone27889 在 2019-12-18 09:00:23 更新了该回帖
    你先别求我。。我看看其他人的建议。分给你说不定别人都不屑回答了trollface
    someone9891 •
  • remixjc •

    建议自己写一篇文章，制定自己的规范，让他们遵守就可以了。
    大致内容如下：

    1. 统一 GUI 工具，比如小乌龟TortoiseGit
    2. 分支创建与维护交给自己来管理
    3. 分享 git 的操作基本内容等，例如：https://www.remixjc.cn/articles/2019/12/20/1576806915902.html
    4. 在平时操作时有问题及时问
    5. 分享发现冲突与解决冲突的方法，避免强制推送导致代码覆盖，合并时一定不要忘记把别人的代码合并
  • MistRay • • 1 • 1 评论
    订阅者 支持者 勇士

    git flow 想要严格遵守不是特别容易.这玩意还是有学习成本的.
    我前段时间在公司推过这个规范,但基本没人关心怎么提交代码.
    现在用起来的基本只有 master,feature,develop.
    剩下分支种类,只要我不和他们说,他们就不用.
    补充:
    如果没有把 ci 用起来的话,分支合来合去,心里会很没底.

    1 回复
    目前的话我是参照 Git flow 简化了一下，到时候跟其他同事讨论讨论，再发出去给大家吧
    someone9891 •
  • 查看全部回帖
someone9891
兰州
回帖
1339
 帖子
112
 积分
31242

近期热议

推荐标签 标签

  • TensorFlow

    TensorFlow 是一个采用数据流图（data flow graphs），用于数值计算的开源软件库。节点（Nodes）在图中表示数学操作，图中的线（edges）则表示在节点间相互联系的多维数据数组，即张量（tensor）。

    20 引用 • 19 回帖 • 2 关注
  • gRpc
    10 引用 • 8 回帖 • 52 关注
  • Spark

    Spark 是 UC Berkeley AMP lab 所开源的类 Hadoop MapReduce 的通用并行框架。Spark 拥有 Hadoop MapReduce 所具有的优点；但不同于 MapReduce 的是 Job 中间输出结果可以保存在内存中，从而不再需要读写 HDFS，因此 Spark 能更好地适用于数据挖掘与机器学习等需要迭代的 MapReduce 的算法。

    74 引用 • 46 回帖 • 549 关注
  • 宕机

    宕机，多指一些网站、游戏、网络应用等服务器一种区别于正常运行的状态，也叫“Down 机”、“当机”或“死机”。宕机状态不仅仅是指服务器“挂掉了”、“死机了”状态，也包括服务器假死、停用、关闭等一些原因而导致出现的不能够正常运行的状态。

    13 引用 • 82 回帖 • 32 关注
  • GAE

    Google App Engine（GAE）是 Google 管理的数据中心中用于 WEB 应用程序的开发和托管的平台。2008 年 4 月 发布第一个测试版本。目前支持 Python、Java 和 Go 开发部署。全球已有数十万的开发者在其上开发了众多的应用。

    14 引用 • 42 回帖 • 698 关注
  • HHKB

    HHKB 是富士通的 Happy Hacking 系列电容键盘。电容键盘即无接点静电电容式键盘（Capacitive Keyboard）。

    5 引用 • 74 回帖 • 414 关注
  • SendCloud

    SendCloud 由搜狐武汉研发中心孵化的项目，是致力于为开发者提供高质量的触发邮件服务的云端邮件发送平台，为开发者提供便利的 API 接口来调用服务，让邮件准确迅速到达用户收件箱并获得强大的追踪数据。

    2 引用 • 8 回帖 • 445 关注
  • 区块链

    区块链是分布式数据存储、点对点传输、共识机制、加密算法等计算机技术的新型应用模式。所谓共识机制是区块链系统中实现不同节点之间建立信任、获取权益的数学算法 。

    91 引用 • 751 回帖
  • Telegram

    Telegram 是一个非盈利性、基于云端的即时消息服务。它提供了支持各大操作系统平台的开源的客户端，也提供了很多强大的 APIs 给开发者创建自己的客户端和机器人。

    5 引用 • 35 回帖 • 1 关注
  • CSS

    CSS（Cascading Style Sheet）“层叠样式表”是用于控制网页样式并允许将样式信息与网页内容分离的一种标记性语言。

    181 引用 • 448 回帖
  • CloudFoundry

    Cloud Foundry 是 VMware 推出的业界第一个开源 PaaS 云平台，它支持多种框架、语言、运行时环境、云平台及应用服务，使开发人员能够在几秒钟内进行应用程序的部署和扩展，无需担心任何基础架构的问题。

    5 引用 • 18 回帖 • 155 关注
  • 单点登录

    单点登录（Single Sign On）是目前比较流行的企业业务整合的解决方案之一。SSO 的定义是在多个应用系统中，用户只需要登录一次就可以访问所有相互信任的应用系统。

    9 引用 • 25 回帖 • 1 关注
  • Vue.js

    Vue.js（读音 /vju ː/，类似于 view）是一个构建数据驱动的 Web 界面库。Vue.js 的目标是通过尽可能简单的 API 实现响应的数据绑定和组合的视图组件。

    261 引用 • 662 回帖
  • JWT

    JWT（JSON Web Token）是一种用于双方之间传递信息的简洁的、安全的表述性声明规范。JWT 作为一个开放的标准（RFC 7519），定义了一种简洁的，自包含的方法用于通信双方之间以 JSON 的形式安全的传递信息。

    20 引用 • 15 回帖 • 23 关注
  • Gzip

    gzip （GNU zip）是 GNU 自由软件的文件压缩程序。我们在 Linux 中经常会用到后缀为 .gz 的文件，它们就是 Gzip 格式的。现今已经成为互联网上使用非常普遍的一种数据压缩格式，或者说一种文件格式。

    9 引用 • 12 回帖 • 113 关注
  • 黑曜石

    黑曜石是一款强大的知识库工具，支持本地 Markdown 文件编辑，支持双向链接和关系图。

    A second brain, for you, forever.

    10 引用 • 86 回帖 • 1 关注
  • LeetCode

    LeetCode（力扣）是一个全球极客挚爱的高质量技术成长平台，想要学习和提升专业能力从这里开始，充足技术干货等你来啃，轻松拿下 Dream Offer！

    209 引用 • 72 回帖
  • JSON

    JSON （JavaScript Object Notation）是一种轻量级的数据交换格式。易于人类阅读和编写。同时也易于机器解析和生成。

    51 引用 • 190 回帖 • 3 关注
  • Vditor

    Vditor 是一款浏览器端的 Markdown 编辑器，支持所见即所得、即时渲染（类似 Typora）和分屏预览模式。它使用 TypeScript 实现，支持原生 JavaScript、Vue、React 和 Angular。

    320 引用 • 1679 回帖
  • webpack

    webpack 是一个用于前端开发的模块加载器和打包工具，它能把各种资源，例如 JS、CSS（less/sass）、图片等都作为模块来使用和处理。

    41 引用 • 130 回帖 • 292 关注
  • 房星科技

    房星网，我们不和没有钱的程序员谈理想，我们要让程序员又有理想又有钱。我们有雄厚的房地产行业线下资源，遍布昆明全城的 100 家门店、四千地产经纪人是我们坚实的后盾。

    6 引用 • 141 回帖 • 561 关注
  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发，最早发布于 2014 年 9 月。

    57 引用 • 22 回帖 • 5 关注
  • jsoup

    jsoup 是一款 Java 的 HTML 解析器，可直接解析某个 URL 地址、HTML 文本内容。它提供了一套非常省力的 API，可通过 DOM，CSS 以及类似于 jQuery 的操作方法来取出和操作数据。

    6 引用 • 1 回帖 • 466 关注
  • OkHttp

    OkHttp 是一款 HTTP & HTTP/2 客户端库，专为 Android 和 Java 应用打造。

    16 引用 • 6 回帖 • 52 关注
  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库，并提供多种语言的 API。从 2010 年 3 月 15 日起，Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始，Redis 的开发由 Pivotal 赞助。

    284 引用 • 247 回帖 • 164 关注
  • 微信

    腾讯公司 2011 年 1 月 21 日推出的一款手机通讯软件。用户可以通过摇一摇、搜索号码、扫描二维码等添加好友和关注公众平台，同时可以将自己看到的精彩内容分享到微信朋友圈。

    129 引用 • 793 回帖
  • B3log

    B3log 是一个开源组织，名字来源于“Bulletin Board Blog”缩写，目标是将独立博客与论坛结合，形成一种新的网络社区体验，详细请看 B3log 构思。目前 B3log 已经开源了多款产品：Sym、Solo、Vditor 和 思源笔记。

    1083 引用 • 3461 回帖 • 281 关注

最新标签