GitHubのpermalinkを使ってPull Requestやissueで載せるコードをわかりやすくしよう
GitHubでissueやPull Requestに残す時にコードのリンクの貼ったコメントをよくやる。
しかし、こんな感じでコードを選択した状態のURLを
こんな感じでリンクを貼ったコメントをすると、もし将来的に該当箇所のコードに対して手を加えた後にこのリンクを
クリックすると、おそらく本来選択した箇所とはズレて表示されるので、過去のissueやPull Requestを調べる時にコードが追えない
(しかも、パッと見わかりづらい)
GitHubのpermalinkを使う
GitHubでは、permalinkという機能があり、permalinkは将来的にコードを変更しても、 本来選択した箇所とはズレて表示されることはなく、さらに直接コードが表示される。
やり方
- 従来通り、まず1行選択した状態から
SHIFTキーを推しながら、選択したいところまでの行をクリックする。 そうすると、横に...という表示が出てくる
...をクリックした後、Copy permalinkというリンクをクリックするとCopied!という表示になり、 クリップボードにpermalinkがコピーされる。
...をクリックするのが面倒なら1.の状態でyキーを押して、ブラウザのURL欄を見ると permalinkが生成されているため、それをコピーしてもOK!
- あとは、生成したpermalinkをPull Requestのissueで貼ってみると...
こんな感じでpermalinkにする前のコードのリンクに比べて、明らかにわかりやすくなりました!
普段GitHubを利用している時にpermalinkであることに気づかずに貼ってコメントした時に、
「アレ? 何かよくわかんないけどわかりやすくなってる!」
みたいな感じでよくわかっていなかった機能ですが最近、先輩エンジニアの方に教えて頂いてやっとわかりました!!
参考
公式に思いっきり書いてありました😅
Getting permanent links to files - GitHub Help
Creating a permanent link to a code snippet - GitHub Help
