从这里开始:git - Llama-Group/Project-Llama GitHub Wiki

该页面为您介绍了 Git 的基础使用方法,尝试使用 Git 来为项目做贡献吧

名词表:

  • Pull-request 即 PR --> 变更请求
  • Push --> 推送
  • Commit --> 注释
  • Branch --> 分支
  • Merge --> 合并
  • Issue --> 事项
  • Pull --> 拉取

本项目的 Git 使用规范:

  • 整个项目的每个版本以创建不同分支(branch)的形式实现。
  • 使用变更请求来向团队其他人汇报你的进度, 每次你推送一个新的分支之后, 一个就建好了,之后其他人就可以检查你的代码,并选择是否合并你的代码到主分支去。(我们会检查你代码的质量, 符合要求即可合并)
  • 每一个变更请求由一个或多个commit组成,commit应该包括你做过变动的地方,或者针对变动进行的解释。
  • 例:在 A 城最有名的景观就是动物墙了,这是由当地的一个艺术家协会组建的,以在各个地方的墙面上绘画动物风靡全城的景观,现在初出茅庐的你也想尝试一下,于是你创建了个叫小动物墙的项目(也准备在上面画各式各样的动物), 创建之后的第一件事就是在墙上画个大象(这时你需要创建一个本地的分支), 分支创建之后,就开始在电脑上作画了, 你先画了四条腿(这是你的第一个commit), 然后画了大象的头和尾巴(另外一个commit), 于是你就画完了这个大象, 画完之后的你心满意足,想找大师们来看看你的杰作(此时创建了一个变更请求), 对方看了之后大呼神(niu)作(bi)! 然后在旁边把小动物墙的小字给去掉了,加入了动物墙的 Logo,至此,你的杰作就成了动物墙项目的一部分了。(大师们最后把你的小动物墙项目与动物墙项目合并了).

以下是代码实例:

开始之前, 建立一个分支:(先 Clone 一下主分支)

git clone --recursive https://github.com/Llama-Group/Project-Llama

下次你想从主分支更新内容的时候,不需要再 Clone ,只需要做如下操作:

git pull --recurse-submodules

注意:Pull 之前先 cd 到项目目录下

为项目贡献之前,记得建立你自己的分支

git checkout -b [your_branch_name]

分支命名规则:

为了使项目更整洁,请在命名分支前使用如下规范:

Prefix list:

  • feature/
  • fix/
  • refactor/

注释:

git commit -s

注释风格规范:

  • [Title]
  • [Blank line]
  • [Detail]
  • [Blank line]
  • [Automatically added sign-off]

事项: 如果你想发布些计划或者想请求他人协助你,请在 Github 上发布 Issue.

推送:

git push origin [branch name]

合并:

当你的 PR 存在冲突时,记得将你的分支与主分支合并。

git checkout master
git pull
git checkout [your branch]
git merge master

然后去解决冲突。

最后把你的分支与主分支合并(该操作需要高级权限)

⚠️ **GitHub.com Fallback** ⚠️