最近有一些小伙伴反映希望可以增加一些 GitHub 使用技巧,这里推荐一篇入门技巧给大家~本系列会持续更新~
本篇 原文 由 Taichi 社区同学 xuanwo 整理发布在自己的博客中,我对其中的一些部分做了修改更适合 Taichi 的用户阅读,已获得作者授权,感谢 xuanwo~
–正文开始–
今天跟大家聊聊我经常使用的 Github 实用小技巧:
- 引用 GitHub Issues/PR/Discussion
- 使用 Fix / Close 来关联一个 Issue
- 可折叠的区块
- Draft / Ready for review
- 请求 Review
- 引用回复
引用 GitHub Issues/PR/Discussion
在 GitHub 的任何编辑框都可以使用 #
+ Issues/PR/Discussion 数字 ID 的形式来引用:
使用 Fix / Close 来关联一个 Issue
在 PR 中可以使用 Fix #xxx
的语法来关联一个 issue,当 PR 被 Merge 的时候,能一同 close 对应的 Issue。
- 可以使用的关键词非常宽泛:[close|fix|resolve][s|ed] 的任意组合都可以
- 注意关联多个 issue 的话需要重复写
fix #xxx
:fix #xxx,#yyy
是不起作用的,只有第一个会生效 - 有 Repo 权限的维护者也可以在侧边栏手动关联:不过感觉不是特别好用,有些 issue 搜索不出来
文档参见:Linking a pull request to an issue
可折叠的区块
在 Issues 和 PR 中有时候会想展示折叠的内容,比如长长的完整日志,详细的结果等,这时候可以使用 HTML5 中增加的折叠语法:
<details>
<summary>Summary Goes Here</summary>
...this is hidden, collapsable content...
</detials>
显示效果如下:
不过使用的时候需要注意内容跟 <details>
tag 留一个空行,否则有些 Markdown 语法无法正常渲染。
参见: Using in GitHub
Draft / Ready for review
如果想要标记 PR 当前仍在工作中,不要进行 review 或者 merge 的话,可以使用 GitHub 原生的 Draft / Ready for review 工作流。
创建 PR 的时候选择 Create draft pull request
:
当 PR 准备好 review 时,点击 PR 最下方的 Ready for review
:
这样做的好处是不需要引入外部的 bot 和 actions,也不需要作者手动更新 PR 标题,GitHub 会保证这个 PR 无法被 merge。
请求 Review
推荐使用 GitHub Request Review 机制来请求维护者 Review:
通过这种方式发起的 Review 请求会在维护者的通知中有专门的标记:
这能够避免比淹没在一堆
commented
和 mention
之中:热门项目的维护者每天可能有上百个通知,他们很多时候会使用过滤器来过滤出 review requested
的通知。
引用回复
在 GitHub 上回复评论时请尽可能避免全文引用,只选择自己具体想回应的话:选中自己想要回复的话,然后点开 comment 的菜单,选中 Quote Reply
然后就会自动跳转到回复框:
这样做的好处在于:
- 避免 Issues / PR 被无用的信息刷屏
- 回答更精准,更能让读者知道当前在回复什么东西
推友 @_a_wing 指出可以使用快捷键 r
:
- 选中想要回复的文字
- 点击一下字母键
r
即可快速回复
亲测有效,比鼠标点击菜单更快,推荐使用