github-cheat-sheet

GitHub秘籍

本秘籍收录了一些Git和Github非常酷同时又少有人知的功能。灵感来自于Zach Holman在2012年Aloha Ruby Conference和2013年WDCNZ上所做的演讲:Git and GitHub Secrets(slides)和More Git and GitHub Secrets(slides)。

Read this in other languages: English, 한국어, 日本語, 简体中文.

目录

GitHub

忽略空白字符变化

在任意diff页面的URL后加上?w=1,可以去掉那些只是空白字符的变化,使你能更专注于代码的变化。

Diff without whitespace

详见 GitHub secrets.

调整Tab字符所代表的空格数

在diff或者file页面的URL后面加上?ts=4,这样当显示tab字符的长度时就会是4个空格的长度,不再是默认的8个空格。ts后面的数字还可以根据你个人的偏好进行修改。不过,这个小诀窍在Gists页面和raw file页面不起作用。

下面是我们在Go语言的source file页面URL后加?ts=4的例子:

Before, tab space example

然后是我们添加?ts=4的例子:

After, tab space example

查看某个用户的Commit历史

查看某个用户的所有提交历史,只需在commits页面URL后加上?author=username

https://github.com/rails/rails/commits/master?author=dhh

DHH commit history

深入了解提交视图之间的区别

克隆某个仓库

当我们克隆某一资源时,可以不要那个.git后缀。

$ git clone https://github.com/tiimgreen/github-cheat-sheet

更多对 Git clone 命令的介绍.

将某个分支与其他所有分支进行对比

当你点击某个仓库的分支(Branches)选项卡时

https://github.com/{user}/{repo}/branches

你会看到一个包含所有未合并的分支的列表。

你可以在这里查看比较(Compare)页面或点击删除某个分支。

Compare branches not merged into master in jquery/jquery repo - https://github.com/jquery/jquery/branches

有的时候我们需要将多个分支与一个非主分支(master)进行对比,此时可以通过在URL后加入要比较的分支名来实现:

https://github.com/{user}/{repo}/branches/{branch}

Compare branches not merged into `1.x-master` in jquery/jquery repo - https://github.com/jquery/jquery/branches/1.x-master

可以在URL后加上?merged=1来查看已经合并了的分支。

Compare branches merged in to `1.x-master` in jquery/jquery repo - https://github.com/jquery/jquery/branches/1.x-master?merged=1

你可以使用这个界面来替代命令行直接删除分支。

比较分支

如果我们想要比较两个分支,可以像下面一样修改URL:

https://github.com/user/repo/compare/{range}

其中{range} = master...4-1-stable

例如:

https://github.com/rails/rails/compare/master...4-1-stable

Rails branch compare example

{range}还可以使用下面的形式:

https://github.com/rails/rails/compare/master@{1.day.ago}...master
https://github.com/rails/rails/compare/master@{2014-10-04}...master

日期格式 YYYY-DD-MM

Another compare example

...这样你就能查看master分支上一段时间或者指定日期内的改动。

了解更多关于比较跨时间段的提交记录.

比较不同派生库的分支

想要对派生仓库(Forked Repository)之间的分支进行比较,可以像下面这样修改URL实现:

https://github.com/user/repo/compare/{foreign-user}:{branch}...{own-branch}

例如:

https://github.com/rails/rails/compare/byroot:master...master

Forked branch compare

Gists

Gists 给我们提供了一种不需要创建一个完整的仓库,使小段代码也可以工作的简单方式。

Gist

Gist的URL后加上.pibb,可以得到更适合嵌入到其他网站的HTML版本。

Gists还可以像任何标准仓库一样被克隆。

$ git clone https://gist.github.com/tiimgreen/10545817

Gists

进一步了解如何创建 gists.

Git.io

Git.io是Github的短网址服务。

Git.io

你可以通过Curl命令以普通HTTP协议使用它:

$ curl -i http://git.io -F "url=https://github.com/..."
HTTP/1.1 201 Created
Location: http://git.io/abc123

$ curl -i http://git.io/abc123
HTTP/1.1 302 Found
Location: https://github.com/...

进一步了解 Git.io.

键盘快捷键

在仓库主页上提供了快捷键方便快速导航。

  • t 键会打开一个文件浏览器。
  • w 键会打开分支选择菜单。
  • s 键会激活顶端的命令栏 (Command Bar)。
  • l 键编辑Issue列表页的标签。
  • 查看文件内容时(如:https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md),按 y 键将会冻结这个页面,这样就算代码被修改了也不会影响你当前看到的。

?查看当前页面支持的快捷键列表:

Keyboard shortcuts

进一步了解如何使用 Command Bar.

整行高亮

在代码文件地址后加上#L52或者单击行号52都会将第52行代码高亮显示。

多行高亮也可以,比如用#L53-L60选择范围,或者按住 shift键,然后再点击选择的两行。

https://github.com/rails/rails/blob/master/activemodel/lib/active_model.rb#L53-L60

整行高亮

用commit信息关闭Issue

如果某个提交修复了一个Issue,当提交到master分支时,提交信息里可以使用fix/fixes/fixed, close/closes/closed 或者 resolve/resolves/resolved等关键词,后面再跟上Issue号,这样就会关闭这个Issue。

$ git commit -m "Fix screwup, fixes #12"

这将会关闭Issue #12,并且在Issue讨论列表里关联引用这次提交。

Closing Repo

进一步了解通过提交信息关闭Issue.

链接其他仓库的Issue

如果你想引用到同一个仓库中的一个Issue,只需使用井号 # 加上Issue号,这样就会自动创建到此Issue的链接。

要链接到其他仓库的Issue,就使用user_name/repo_name#ISSUE_NUMBER的方式,例如tiimgreen/toc#12

Cross-Link Issues

设置CI对每条Pull Request都进行构建

如果配置正确,Travis CI会为每个你收到的Pull Request执行构建,就像每次提交也会触发构建一样。想了解更多关于Travis CI的信息,请看 Travis CI入门

Travis CI status

进一步了解 Commit status API.

Markdown文件高亮语法

例如,可以像下面这样在你的Markdown文件里为Ruby代码添加语法高亮:

```ruby
require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s
```

效果像下面这样:

require 'tabbit'
table = Tabbit.new('Name', 'Email')
table.add_row('Tim Green', 'tiimgreen@gmail.com')
puts table.to_s

Github使用 Linguist 做语言识别和语法高亮。你可以仔细阅读 languages YAML file,了解有哪些可用的关键字。

进一步了解 GitHub Flavored Markdown.

表情符

可以在Pull Requests, Issues, 提交消息, Markdown文件里加入表情符。使用方法:name_of_emoji:

:smile:

将输出一个笑脸:

:smile:

Github支持的完整表情符号列表详见emoji-cheat-sheet.comscotch-io/All-Github-Emoji-Icons

Github上使用最多的5个表情符号是:

  1. :shipit: - :shipit:
  2. :sparkles: - :sparkles:
  3. :-1: - :-1:
  4. :+1: - :+1:
  5. :clap: - :clap:

静态与动态图片

注释和README等文件里也可以使用图片和GIF动画:

![Alt Text](http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif)

Peter don't care

所有图片都缓存在Gitub,不用担心你的站点不能访问时就看不到图片了。

在GitHub Wiki中嵌入图片

有多种方法可以在Wiki页面里嵌入图片。既可以像上一条里那样使用标准的Markdown语法,也可以像下面这样指定图片的高度或宽度:

[[ http://www.sheawong.com/wp-content/uploads/2013/08/keephatin.gif | height = 100px ]]

结果:

Just a screenshot

快速引用

在注释话题里引用之前某个人所说的,只需选中文本,然后按 r键,想要的就会以引用的形式复制到你的输入框里。

Quick Quote

进一步了解快速引用.

快速添加许可证

创建一个仓库时,Github会为你提供一个预置的软件许可列表:

License

对于已有的仓库,可以通过web界面创建文件来添加软件许可。输入LICENSE作为文件名后,同样可以从预置的列表中选择一个作为模板。

License

这个技巧也适用于 .gitignore 文件。

进一步了解 open source licensing.

任务列表

Issues和Pull requests里可以添加复选框,语法如下(注意空白符):

- [ ] Be awesome
- [ ] Prepare dinner
  - [ ] Research recipe
  - [ ] Buy ingredients
  - [ ] Cook recipe
- [ ] Sleep

Task List

当项目被选中时,它对应的Markdown源码也被更新了:

- [x] Be awesome
- [ ] Prepare dinner
  - [x] Research recipe
  - [x] Buy ingredients
  - [ ] Cook recipe
- [ ] Sleep

进一步了解任务列表.

Markdown文件中的任务列表

在完全适配Markdown语法的文件中可以使用以下语法加入一个只读的任务列表

- [ ] Mercury
- [x] Venus
- [x] Earth
  - [x] Moon
- [x] Mars
  - [ ] Deimos
  - [ ] Phobos

进一步了解Markdown文件中的任务列表

相对链接

Markdown文件里链接到内部内容时推荐使用相对链接。

[Link to a header](#awesome-section)
[Link to a file](docs/readme)

绝对链接会在URL改变时(例如重命名仓库、用户名改变,建立分支项目)被更新。使用相对链接能够保证你的文档不受此影响。

进一步了解相对链接.

GitHub Pages的元数据与插件支持

在Jekyll页面和文章里,仓库信息可在 site.github 命名空间下找到,也可以显示出来,例如,使用 {{ site.github.project_title }}显示项目标题。

Jemoji和jekyll-mentions插件为你的Jekyll文章和页面增加了emoji@mentions功能。

了解更多 GitHub Pages的元数据和插件支持.

查看YAML格式的元数据

许多博客站点,比如基于JekyllGitHub Pages,都依赖于一些文章头部的YAML格式的元数据。Github会将其渲染成一个水平表格,方便阅读。

YAML metadata

进一步了解 在文档里查看YAML元数据.

渲染表格数据

GitHub支持将 .csv (comma分隔)和.tsv (tab分隔)格式的文件渲染成表格数据。

Tabular data

进一步了解渲染表格数据.

Diffs

可渲染文档的Diffs

提交和Pull Requests里包含有Github支持的可渲染文档(比如Markdown)会提供sourcerendered 两个视图功能。

Source / Rendered view

点击 "rendered" 按钮,看看改动在渲染后的显示效果。当你添加、删除或修改文本时,渲染纯文本视图非常方便。

Rendered Prose Diffs

进一步了解渲染纯文本视图Diffs.

可变化地图

当你在GitHub上查看一个包含地理数据的提交或pull request时,Github可以显示数据变动的视觉表示。

Diffable Maps

进一步了解可比较地图.

在diff中折叠与扩展代码

你可以通过点击diff边栏里的 unfold 按钮来多显示几行上下文。你可以一直点击 unfold 按钮直到显示了文件的全部内容。这个功能在所有GitHub产生的diff界面都可以使用。

Expanding Context in Diffs

进一步了解扩展Diff上下文.

查看Pull Request的diff和patch

在Pull Request的URL后面加上 .diff.patch 的扩展名就可以得到它的diff或patch文件,例如:

https://github.com/tiimgreen/github-cheat-sheet/pull/15
https://github.com/tiimgreen/github-cheat-sheet/pull/15.diff
https://github.com/tiimgreen/github-cheat-sheet/pull/15.patch

.diff 扩展会使用普通文本格式显示如下内容:

diff --git a/README.md b/README.md
index 88fcf69..8614873 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i
 - [Merged Branches](#merged-branches)
 - [Quick Licensing](#quick-licensing)
 - [TODO Lists](#todo-lists)
+- [Relative Links](#relative-links)
 - [.gitconfig Recommendations](#gitconfig-recommendations)
     - [Aliases](#aliases)
     - [Auto-correct](#auto-correct)
@@ -381,6 +382,19 @@ When they are clicked, they will be updated in the pure Markdown:
 - [ ] Sleep

(...)

渲染图像发生的变动

GitHub可以显示包括PNG、JPG、GIF、PSD在内的多种图片格式并提供了几种方式来比较这些格式的图片文件版本间的不同。

Diffable PSD

查看更多关于渲染图像变动的内容

Hub

Hub是一个对Git进行了封装的命令行工具,可以帮助你更方便的使用Github。

这使得你可以像下面这样进行克隆:

$ hub clone tiimgreen/toc

查看更多Hub提供的超酷命令.

贡献内容的自动检查

假设你想人们使用你的项目并给你的项目做出贡献,你往往需要回答他们常见问题。这个项目是干什么用的?我如何使用它?允许我怎样使用?我如何为项目出力?我怎样配置开发环境?我怎么能保证新功能不会破坏已有的功能?

Friction是一个命令行脚本,用来检查你的项目是否回答了这些问题。下面是示例输出: