GitHub での自動リンク

GitHub での自動リンク

https://docs.github.com/ja/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls

#xxx (xxx は数値)

#xxx (xxx は数値) のように書くと同じレポジトリ内の issue または PR へのリンクになる。

例: #26

これはめっちゃ有名

gh-xxx または GH-xxx(xxx は数値)

gh-xxx (xxx は数値) のように書くと同じレポジトリ内の issue または PR へのリンクになる。

例: gh-26 または GH-26

容易に issue に関連付けられるようにブランチ名に課題番号を入れるときにブランチ名に
#26 とすると # の扱いがややこしいので、代わりに gh-26 を含めるとよいと思う。

owner/repo#xxx

owner/repo#xxx (owner は repository の ower, repo は repository 名、xxx は数値) のように書くと https://github.com/owner/repo/issues/xxx あるいは https://github.com/owner/repo/pull/xxx へのリンクになる。

例: python/cpython#117167 あるいは python/cpython/pull/117168