2015-06-20
issue や MargeRequest を作成するとき、ルールやフォーマットなどガイドラインがあるプロジェクトではメンバーとして参加するとき説明をうけたり、別途ドキュメントとかをもらったりするかもしれませんが、作成するときには、そのガイドラインに沿っていなかったり忘れたりするときもあると思います。
そのようなことを防ぐため？に GitHub や GitLab にはガイドライン用のファイルを指定のファイル名で作成することで、issue や MargeRequest を新規作成するときにリンクとして表示してくれます。
GitHub でのガイドラインのリンクを表示する方法は ヘルプページ にあります。
GitLab では リリースノート に機能の説明は載っていたのですが、手順については今回調べることになったのでまとめました。
リポジトリのルートディレクトリ直下にファイル名 CONTRIBUTING.md または CONTRIBUTING で作成。
CONTRIBUTING.md と CONTRIBUTING の両方が存在したときは CONTRIBUTING が優先されるようです。
Markdown 形式のほうがファイル単体で表示するときにも見やすいので、作成するときには CONTRIBUTING.md が良さそうです。