以前こちらでgithubのプルリクエストのテンプレート機能をご紹介しましたが、
https://qiita.com/a-nishimura/items/0c43a0a5fe6dc817729d
テンプレートとは別にコントリビュータのためのガイドライン作成機能もあるのでメモです。
チームの新規アサイン時などに、概要やガイドライン、PRのテンプレートとサンプルのメンバーへの周知などに活用すると便利ですね。
Contributor導入方法
contributing.mdまたはCONTRIBUTING.md
というファイル名でガイドラインを作ります。
内容はこんな感じ
# contributors template test
## title
- hogehoge
- fugafuga
## memo
- memomemo
※ファイル拡張子の指定は特にないようだが、マークダウン形式で記載しておくと整形されるので便利かと思います。
このファイルを
- リポジトリのルート直下
- docsフォルダを作成してその配下
- .githubフォルダを作成してその配下
のいずれかにpushします。
するとプルリクエスト作成時にcontributingのリンクが表示されます。
Open a pull requestのプルリクエスト作成時にのみリンクが表示されます。
既存のpull requestのview時には表示されません。