GitHub の CONTRIBUTING には何を書けばいいのか？

目次

1. はじめに
2. サンプル
3. 参考

はじめに

GitHubのOSSプロジェクトを見ているとリポジトリのルート直下に存在する CONTRIBUTING.md というファイルをよく目にします。 これは、OSSに対してコントリビュートする際に目を通すべきことが書かれているものです。

具体的にどんなことを書けば良いのかを調べてみました。

サンプル

それはサンプルをいくつか見ていきます。

js-primer

https://github.com/asciidwango/js-primer/blob/master/CONTRIBUTING.md

(JS)ECMA2015以降の文法を体系的に学べるドキュメントのリポジトリの CONTRIBUTING です。

大項目を見ていくと...

• Issuesについて
• プルリクエストの方法
• 開発方法 (開発サーバの起動方法)
• テスト方法
• コミットメッセージの規約
• 書式・ディレクトリ構造・ルール

こんな内容が書かれています。

README にも被る内容が書かれていますが、 CONTRIBUTING は、コマンドやソースコードレベルのより具体的な内容に触れています。

参考

https://github.blog/2012-09-17-contributing-guidelines/