Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

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

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

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

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

contributing-guidelines

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

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

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

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

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

CONTRIBUTING ファイルを追加する

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

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

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

参考資料