像专业人士一样使用 GitHub!——8 个秘诀、技巧和窍门
我使用 GitHub 已经有一段时间了,一路走来,我积累了一些技巧,也发现了一些管理 GitHub、充分发挥其性能以及个性化体验的秘诀。今天我想分享一些我最喜欢的技巧,相信其中也有一些对你有帮助的新方法。
引言
今天我们来聊聊GitHub,以及如何更好地、更智能地或者至少更方便地使用它。
正如我之前提到的,在使用 GitHub 时有很多技巧、窍门和“秘诀”,即使是资深用户或长期用户,可能也未必都知道其中的一些。
让我们一起来看看吧!
秘诀、技巧和窍门
- 模糊查找器
- 八叉树
- 关闭问题时支持的关键字
- 超级连杆
- 代码片段链接
- 必备的 Markdown 格式设置技巧
- 神奇网址
- 分支自动删除
视频
如果您是视觉型学习者,或者更喜欢观看和聆听而不是阅读,这里有一个包含完整解释的视频,公平地说,它比这篇文章要全面得多。
如果你更喜欢阅读,那……我们就继续吧 :)
模糊查找器
第一个是“模糊查找器”。
你有没有试过在大型 GitHub 代码库中查找某个特定文件却怎么也找不到?我有过。不过,这个技巧可以帮到你。
在任何存储库页面中,按键盘上的t 键即可访问该存储库,然后开始输入要查找的文件的名称。
只需输入几个字母,查找器就会自动筛选文件列表,然后使用箭头键在结果之间移动。按下回车键……瞧!查找任何文件都超级简单。
告别在代码仓库中浏览目录的繁琐操作。
八叉树
说到查找文件,我们来看第二个技巧。
这是唯一一个需要用到GitHub尚未集成的功能的方法。有一个很棒的浏览器扩展程序叫做Octotree,它可以帮助你浏览目录,并以熟悉的树状结构打开文件。
您可以在https://octotree.io找到它,它在 GitHub 上完全开源。
点击这里观看我的视频,看看它的实际效果。
加分项:它支持 GitHub Enterprise,而且他们还提供免费版本!
关闭问题时支持的关键字
下一站,或许算不上秘密,但肯定没有多少详细记载。
我们来讨论一下用于关闭问题的关键词。
您可能已经知道,提交代码时可以添加一条消息,自动关闭关联的问题。通常人们会使用“修复 # 号”这样的语句,其中数字是问题的编号。
例如,“修复 #12 ”以关闭问题编号 12。
但还有很多其他方法可以使用。以下是列表:
fix #12
fixes #12
fixed #12
close #12
closes #12
closed #12
resolve #12
resolves #12
resolved #12
使用上述任一方法,提交操作都会自动关闭该问题。
额外提示:如果提交内容在 PR 中,则合并后问题将被关闭。
超级连杆
接下来是 SuperLinter。
为不同类型的代码配置合适的代码检查工具,搭建一个全新的代码仓库,既耗时又繁琐。可供选择的工具和配置方案实在太多,而且通常需要不止一个代码检查工具才能覆盖所有使用的编程语言。
现在情况不同了。Super Linter 是一个源代码仓库,它被打包到 Docker 容器中,并通过 GitHub Actions 调用。这使得 GitHub.com 上的任何仓库都可以调用 Super Linter 并开始利用它的优势。您可以在这里找到更多信息。
再次提醒,请点击此处观看我的视频,了解更多详情。
代码片段链接
其实这算不上什么秘密,但肯定不是人人都知道,而且偶尔还会让人大吃一惊。
在查看文件时,您可以通过单击行号链接到特定的代码行。
默认情况下,行号(例如 #L1337)会附加到 URL 中,这样总是会直接跳转到该行。
您还可以按住 SHIFT 键并选择起始行和结束行,从而链接到行号范围。
如果该文件被编辑、删除或重命名,链接将无法正常工作。不过,您可以按键盘上的“y”键或点击“复制永久链接”来生成始终有效的规范网址。
额外福利:如果您在 GitHub 评论中添加代码片段的永久链接,就会出现代码的精美可视化效果。
我的视频里有一个非常全面的例子。
必备的 Markdown 格式设置技巧
现在我们来谈谈 Markdow。
GitHub Flavored Markdown 非常适合文本和基本表格的默认格式,但有时你需要发挥创造力才能让它实现你想要的功能。
首先我想向大家展示的是键盘标签。
你可以使用<kbd>标签让文本看起来像按钮,这与普通的反引号文本略有不同。它非常适合在你的 README/wiki 文件中记录键盘快捷键或游戏控制等内容。
类似这样(但在 GitHub 上渲染效果更好):
Use <kbd>ALT</kbd>+<kbd>F4</kbd> to make the magic happen!
使用ALT+ 号F4让奇迹发生!
另一个很酷的功能是可视化十六进制代码。
将十六进制颜色放在反引号中,即可渲染出该颜色的图块。我觉得这简直太棒了!
类似这样(仅在 GitHub 上有效):
GitHub贡献图表颜色:
`#C6E48B` `#7AC96F` `#249A3C` `#196127`
这很酷,但我们来看看一些既酷又有用的格式。
您可以使用反引号和 diff 命令来可视化差异,该命令会根据行首的“减号”或“加号”将行突出显示为红色或绿色。
'''diff
This line is unchanged.
- This line has been removed
+ This instead has been Added
+ And this has been added too!
'''
This line is unchanged.
- This line has been removed
+ This instead has been Added
+ And this has been added too!
最后,关于 Markdown 格式……你知道吗?你可以在评论中添加类似手风琴的按钮,让它们更小巧,而且说实话,看起来更酷炫!快来看看吧。
这仅在 GitHub 上显示
<details>
<summary>Click here to see terminal history + debug info</summary>
<pre>
488 cd /opt/LLL/controller/laser/
489 vi LLLSDLaserControl.c
490 make
491 make install
492 ./sanity_check
493 ./configure -o test.cfg
494 vi test.cfg
495 vi ~/last_will_and_testament.txt
496 cat /proc/meminfo
497 ps -a -x -u
498 kill -9 2207
499 kill 2208
500 ps -a -x -u
501 touch /opt/LLL/run/ok
502 LLLSDLaserControl -ok1
观看我的视频,即可了解它的实际效果。
神奇网址
接下来,我们来谈谈网址。
你知道吗?你只需一个网址就能获取用户或组织的头像!
您可以通过访问以下链接获取任何 GitHub 用户或组织的头像:https://github.com/<username>.png!
例如,这是我的:https://github.com/n3wt0n.png。
例如,当您构建依赖于 GitHub 帐户的网站或设计时,例如“所有贡献者”表格视图或 Probot 的应用程序目录,这将非常有用。
但这还不是全部。您也可以在浏览器中以同样简单的方式获取提交或拉取请求的补丁或差异:
https://github.com/<owner>/<repo>/commit/<sha>.diffhttps://github.com/<owner>/<repo>/commit/<sha>.patch
你也可以对拉取请求执行相同的操作:
https://github.com/<owner>/<repo>/pull/<id>.diffhttps://github.com/<owner>/<repo>/pull/<id>.patch
分支自动删除
好了,今天最后一个。
与其说这是个技巧,不如说它是一个非常很棒的功能,但由于它比较新,我想重点介绍一下。
在您的存储库设置中,您可以启用“自动删除头分支”,这将删除已合并的拉取请求的头分支。
除非你依赖长期存在的分支(你真的不应该这样做!),否则这只是一个快速的改进。如果你愿意,可以随时恢复已删除的分支,所以没有任何风险。
我个人总是会立即删除分支,所以为什么不将其自动化呢?
结论
希望这里能找到一些对你有帮助的新内容。
你觉得怎么样?你之前都了解这些吗?
你还有其他建议想分享吗?
请在评论区告诉我。
参考文献和链接
关于这些秘诀、技巧和窍门的 YouTube 视频:https://youtu.be/sGnqVAfnZ6U
包含示例的 GitHub 代码库:https://github.com/n3wt0n/GitHubSecrets
OctoTree:http: //octotree.io
SuperLinter: https: //github.com/github/super-linter/