GitHub协作指南 | 青训营笔记

72 阅读3分钟

这是我参与「第四届青训营 」笔记创作活动的的第5天

环境

  • windows系统需要安装git

    • 安装地址:git-scm.com/download/wi…
    • 检查是否安装成功:终端输入,git --version,返回版本号即安装成功。
  • macOS\Linux系统自带git无需安装
  • Github官网:github.com/ ,如果没有账号可以注册一个。

协作步骤

说明:这里以前端仓库为例,后端仓库也是如此。

  1. 在GitHub上Fork项目

  1. 克隆项目到本地

  • 本地进入一个空文件夹,右键点击git bash或者终端。

  • 执行git clone命令,地址位你fork后的仓库git地址,每个人的都不一样。可以看到本地出现了bi-front项目文件夹,我们使用VSCode或者WebStorm打开这个文件夹。

3.新建本地开发分支

  1. 查看远程分支。在IDE中打开终端,输入git remote -v,如图所示,只有一个origin远程分支
git remote -v

  1. 新建开发分支
# 查看本地分支,此时本地应该只有master分支
git branch
# 我们不应该在master分支上开发代码,应该新建一个分支在此进行开发;
# 该命令是新建一个分支并切换到此分支;是git branch和git checkout的组合命令。这里分支名可以随便起,比如我这里的命令是git checkout -b coder-zc,新建一个coder-zc分支。
git checkout -b (分支名)
  1. 添加上游仓库
  • 上游仓库的地址都是一样的,也就是汇聚我们所有人提交的代码的仓库。
git remote add upstream https://github.com/coder-zc/bi-front.git

# upstream名字也是随便取的,如果写错了,可以执行删除远程分支命令
git remote remove 分支名
  • 查看我们远程分支,会有两个远程仓库。

  • 两个远程仓库的说明

    • origin:是我们提交代码的远程仓库,即我们本地的代码会提交到这个远程仓库,也是我们自己的仓库。如何把我们的代码提交到upstream仓库呢,通过发起PullRequest向上游仓库发起合并请求,如果通过,则代码会合入上游仓库。
    • upstream:是我们更新代码的仓库,每次提交代码前会从此仓库拉最新的代码,然后再提交。

4. 提交代码

  • 在每次提交代码前都向上游仓库同步一下代码,拉取dev分支的代码,master是保护分支。
git pull upstream dev
# 提交所有修改,你也可以提交部分修改
git add .

# 引号内容为提交时的注释,为了规范提交,请按照此格式编写,feat/fix/doc/...:描述你做了什么修改,要简练清晰,feat表示你新增的什么功能,fix表示你修改了什么Bug,doc表示文档类的修改,下面是个示例。
git commit -m "doc:修改README.md"

# 提交代码到origin仓库,这里coder-zc是我的本地分支,你要换成你的分支名
git push -u origin coder-zc:master

5.发起Pull Request合并代码

  • 此时代码已经提交到master仓库
  • 然后我们new 一个PR

  • 注意分支的选取

至此,你的PR如果同意合并,你就成功对此项目做出贡献。