跳到内容

快速上手 NBTCA 的 GitHub 工作流

NBTCA 的事务与代码都在 GitHub 上管理:一件事开一个 Issue 跟踪,改动在自己的分支上做,通过 Pull Request 请求合并、由他人评审。本文带你把这套流程完整跑一遍。

目前 NBTCA 社内的常见工作场景

  • 多个社员参与同一件事务
  • 多个事务在同一个时间段
  • 多个时间段事务并行执行

那为什么是 GitHub 工作流

  • 主要还是为了用上 Git
  • 刚好相关事务也关联我们的代码库

基本原理

先对齐四个概念,后面的图和操作就都好懂了:

  • Issue:一件事务的跟踪单——谁在做、聊到哪、做没做完,都沉淀在这里;
  • 分支(branch):你的平行工作区,随便改,改坏了也不影响主分支;
  • Pull Request(PR):“请把我的改动合进来”的请求,同时是评审与讨论的入口;
  • 合并(merge):评审通过、改动进入主分支,事务闭环。

一些示范

代码库的github流程我就按下不表了,我想感兴趣自己了解会很快

检查目前我们正在关注的事务

访问 Roadmap

Roadmap主界面

找个感兴趣的Issue看看

MC服务器管理对接#63

群贤毕至嗷

Assignees

设置个标签方便分类

Label-Setup

订阅通知,会发到邮箱去

Subscribe

编辑内容支持markdown语法,所以几乎都能写

什么?不想在浏览器看?

那当然也是有的看滴😋

gh-issue-list

gh-issue-view

这个wiki好像有点说法,看看怎么个事儿

Minecraft-Wiki

看看源码😋

Minecraft-Wiki-gh当然git命令同理

Minecraft-Wiki-git

一派胡言!我来写点😋

Edit

经典丝滑连招

Commit

经验+3,告辞😋

Success


🎉这样就完成了基本的常见NBTCA事务的Github工作流了

ps:你想更进一步?跟我一起来写手册吧😇

附加内容

恭喜你发现了附加内容XD

绝大多数多人协作的代码库都是有分支保护的

主分支被约定为“随时可用”,所以禁止直接向它提交——一切改动先进自己的分支,经评审后合入。

那么在真正的正常提交流程中你一般是在你自己的分支编辑的

Branch

所以你在自己的分支提交到Github后还需要向主分支发起合并请求(Pull Request)

本次以这个教程文档的提交为例

Create-PR

编辑此次PR的内容,并选择你希望审查你本次提交的人员(右上角Reviewers)

Reviewer-PR

你还可以启用Auto-Merge,即在审查通过后自动合并本次源代码提交

Auto-Merge

Reviewer看到的大概是这样:

PR-Reviewer

批准

Approve

合并

Merge

🤓完成!