リポジトリコントリビューターのためのガイドラインを定める

プロジェクトに人々がどのようにコントリビュートするべきかを伝えるガイドラインを作成できます。

この記事の内容

コントリビューションガイドラインについて

プロジェクトの共同作成者が適切な作業を行えるように、コントリビューションガイドラインを含むファイルをプロジェクトリポジトリのルート、docs、または .github フォルダーに追加できます。プルリクエストをオープンした場合や Issue を作成した場合、そのファイルへのリンクが表示されます。

リポジトリのオーナーにとって、コントリビューションガイドラインとは、人々がどのようにコントリビュートするべきかを伝える方法です。

コントリビューターにとって、このガイドラインは、上手に構築されたプルリクエストの提出をしたり、有益な Issue をオープンすることの確認に役立ちます。

オーナーおよびコントリビューターの双方にとって、コントリビューションガイドラインは、プルリクエストや Issue のリジェクトや再提出の手間を未然に軽減するための有効な手段です。

Organization または個人用アカウント用にデフォルトのコントリビューションガイドラインを作成できます。詳しくは、「既定のコミュニティ正常性ファイルの作成」をご覧ください。

Tip

リポジトリの保守担当者は、そのリポジトリの issue や pull request のテンプレートを作成して、issue についての特定のガイドラインを設定できます。詳しくは、「Issueとプルリクエストのテンプレートについて」をご覧ください。

CONTRIBUTING ファイルを追加する

GitHub で、リポジトリのメインページに移動します。
ファイルリストの上にある [Add file ] ドロップダウンメニューを選んで、[ Create new file] をクリックします。

または、左側のファイルツリービューのをクリックしてもかまいません。
リポジトリのルート docs または .github のディレクトリにコントリビューションガイドラインを保存するかどうかを決定します。そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。コントリビューションガイドラインのファイル名では大文字と小文字は区別されません。サポートされているファイル拡張子の場合、ファイルはリッチテキスト形式でレンダリングされます。詳しくは、「非コードファイルの操作」をご覧ください。
- リポジトリのルートディレクトリにコントリビューションガイドラインが表示されるようにするには、「CONTRIBUTING」と入力します。
- リポジトリの docs ディレクトリにコントリビューションガイドラインが表示されるようにするには、「docs/ 」と入力して新しいディレクトリを作成してから、「CONTRIBUTING」を入力します。
- リポジトリに複数の CONTRIBUTING ファイルが含まれている場合、リンクに表示されるファイルは、.github ディレクトリ、リポジトリのルートディレクトリ、最後に docs ディレクトリの順に選択されます。
新しいファイルに、コントリビューションガイドラインを追加します。このガイドラインには、次のことを含めましょう:
- 有意義な Issue やプルリクエストの作成手順
- - 外部ドキュメント、メーリングリストや行動規範へのリンク
- - コミュニティや行動への期待
[変更のコミット...] をクリックします。
[コミットメッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミットメッセージを入力します。コミットメッセージでは、複数の作者にコミットを関連づけることができます。詳しくは、「複数の作者を持つコミットを作成する」を参照してください。
コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。詳しくは、「pull request の作成」を参照してください。
[変更のコミット] または [変更の提案] をクリックします。

コントリビューションガイドラインの例

最初は悩むかもしれませんが、以下のコントリビューションガイドラインの例を役立ててください:

参考資料

オープンソースガイドの「オープンソースプロジェクトを始めよう」セクション
リポジトリへのライセンスの追加