試練の軌跡

プログラミングで出くわした知識やツール、日常生活、働き方その他色々なことをメモしていくブログ

GitHubのpermalinkを使ってPull Requestのissueで載せるコードをわかりやすくしよう

GitHubでissueやPull Requestに残す時にコードのリンクの貼ったコメントをよくやる。
しかし、こんな感じでコードを選択した状態のURLを f:id:bake0937:20180522005845p:plain こんな感じでリンクを貼ったコメントをすると、もし将来的に該当箇所のコードに対して手を加えた後にこのリンクを クリックすると、おそらく本来選択した箇所とはズレて表示されるので、過去のissueやPull Requestを調べる時にコードが追えない
(しかも、パッと見わかりづらい) f:id:bake0937:20180522012127p:plain

GitHubpermalinkを使う

GitHubでは、permalinkという機能があり、permalinkは将来的にコードを変更しても、 本来選択した箇所とはズレて表示されることはなく、さらに直接コードが表示される。

やり方

  1. 従来通り、まず1行選択した状態からSHIFTキーを推しながら、選択したいところまでの行をクリックする。 そうすると、横に...という表示が出てくる f:id:bake0937:20180522011013p:plain
  2. ...をクリックした後、Copy permalinkというリンクをクリックするとCopied!という表示になり、 クリップボードpermalinkがコピーされる。
    ...をクリックするのが面倒なら1.の状態でyキーを押して、ブラウザのURL欄を見ると permalinkが生成されているため、それをコピーしてもOK! f:id:bake0937:20180522011308p:plain
  3. あとは、生成したpermalinkをPull Requestのissueで貼ってみると... f:id:bake0937:20180522012005p:plain

こんな感じでpermalinkにする前のコードのリンクに比べて、明らかにわかりやすくなりました!
普段GitHubを利用している時にpermalinkであることに気づかずに貼ってコメントした時に、
「アレ? 何かよくわかんないけどわかりやすくなってる!」 みたいな感じでよくわかっていなかった機能ですが最近、先輩エンジニアの方に教えて頂いてやっとわかりました!!

参考

公式に思いっきり書いてありました😅
Getting permanent links to files - User Documentation
Creating a permanent link to a code snippet - User Documentation