基于GIT如何共建公共项目

1. 维护范围

1.1 项目组

确定好项目组的主负责人

2. 分支管理

2.1 分支命名

主干分支:master,稳定主干,只合并测试完备的develop分支代码,或fix分支代码
主干开发分支:develop, 日常开发不稳定主干,常用于需求开发分支合并
开发分支:feature_#XXX,用于核心需求开发
个人分支:建议命名someone/task_#XXX

2.2 分支权限

每个仓库应由管理员参照下方规则设置严格的权限,设置路径:设置-分支权限-新建分支权限

分支 身份 push delete PR merge
开发分支 管理员
develop 管理员
master 管理员
分支 身份 push delete PR merge
开发分支 非管理员
develop 非管理员
master 非管理员

2.3 分支合并与删除

每个版本发布后,仓库负责人或管理员应及时将develop分支合并至 master 主干,以保证项目的稳定性。
代码合并完成,开发分支或个人分支如无进一步的开发任务需要删除,避免过多分支留存。
废弃分支将由管理员进行定期清理,以保证分支的干净、有序,一般建议至多保留 5 个分支。

3. Code Review

3.1 原则

  1. 杜绝未经 CR 的代码合并上线
  2. 杜绝代码带冲突合并
  3. 杜绝未格式化的代码合并
  4. 提交 PR 的代码须先通过 eslint 校验且无错误
  5. 提交 PR 的代码须经过自测
  6. 保证 CR 的时效性,在 1 ~ 2 天处理完成,由 CR 发起人跟进并督促合并

3.2 提交PR

  1. PR 标题应简要概括本地 PR 的主要功能点、修改点
  2. PR 描述应详细列举本地 PR 的所有功能点、修改点及其它有必要的信息(设计理念、bug 描述等如有)
  3. PR 描述应按照 commit 类别进行分类展示,分类信息如下:
  • feat:新功能(feature)
  • fix:修补 bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动
  • build: 构建
  • ci: 持续集成
  • perf: 优化
  • revert: 代码回滚

3.3 PR审核设置

每个仓库应由管理员设置默认审核人,默认审核人应包括仓库负责人或管理员,不少于1人,评审规则建议为协同评审,设置路径:设置-评审设置。

4. 版本发布管理

4.1 版本发布负责人

版本发布负责人为仓库负责人或管理员,发布时应遵守下方发布规则,非管理员请勿擅自发布。
版本发布后,负责人应通过各种渠道,包括邮件、快乐平安群、文档等形式通知到应知人员。

4.2 版本管理

npm 的版本号需严格按照语义化版本规范来进行设置,保证新版本的发布不会对在使用中的项目产生影响。

摘录信息:

版本格式:主版本号.次版本号.修订号,版本号递增规则如下:

主版本号:当你做了不兼容的 API 修改,如 1.x -->  2.x
次版本号:当你做了向下兼容的功能性新增,如 1.3 ---> 1.4
修订号:当你做了向下兼容的问题修正,如 1.3.1 ---> 1.3.2
先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面,作为延伸,如 1.0.0-beta 或 1.0.0-rc.1

先行版本的区别:
alpha 版——内部测试版,常用于开发阶段版本测试使用
beta 版——公开测试版,常用于对外部团队、公司开放使用
rc 版——候选版本,常用于进入准发布状态的版本

4.3 发布管理

对于正式版本,发布时需指定npm源还是团队私有源,如下所示:

// 官方源
npm publish --registry=https://registry.npmjs.org

4.4 ChangeLog

ChangeLog应详细记录正式版本的发布内容,描述发布内容可能产生的影响

4.5 Tag

版本发布后,应由版本发布负责人在平台或git上对已发布的版本进行标识,以识别特定的版本,如 v0.1.0、v1.0.0 等,标记该版本的源代码,并提供版本发布信息,用于记录与回溯。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341