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

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

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

contributing-guidelines

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

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

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

ご自分の組織または、個人アカウント向けに既定のコントリビューションガイドラインを作成できます。詳細については、「既定のコミュニティ正常性ファイルの作成」を参照してく� さい。

ヒント: リポジトリの保守担当者は、リポジトリの Issue や pull request のテンプレートを作成して、Issue についての特定のガイドラインを設定できます。詳細については、「Issue と pull request テンプレートについて」を参照してく� さい。

CONTRIBUTING ファイルを追� する

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

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

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

参考資料

オープンソースガイドのセクション「Starting an Open Source Project」(オープンソースプロジェクトの開始)
「リポジトリへのライセンスの追� 」