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

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

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

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

リポジトリに `CONTRIBUTING.md` ファイルが含まれている場合、 GitHub は他の 2 つの場所にも表示され、共同作成者が簡単に見つけられるようになります。

* リポジトリの概要の \[<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-people" aria-label="people" role="img"><path d="M2 5.5a3.5 3.5 0 1 1 5.898 2.549 5.508 5.508 0 0 1 3.034 4.084.75.75 0 1 1-1.482.235 4 4 0 0 0-7.9 0 .75.75 0 0 1-1.482-.236A5.507 5.507 0 0 1 3.102 8.05 3.493 3.493 0 0 1 2 5.5ZM11 4a3.001 3.001 0 0 1 2.22 5.018 5.01 5.01 0 0 1 2.56 3.012.749.749 0 0 1-.885.954.752.752 0 0 1-.549-.514 3.507 3.507 0 0 0-2.522-2.372.75.75 0 0 1-.574-.73v-.352a.75.75 0 0 1 .416-.672A1.5 1.5 0 0 0 11 5.5.75.75 0 0 1 11 4Zm-5.5-.5a2 2 0 1 0-.001 3.999A2 2 0 0 0 5.5 3.5Z"></path></svg> 投稿] タブ (\[<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-book" aria-label="book" role="img"><path d="M0 1.75A.75.75 0 0 1 .75 1h4.253c1.227 0 2.317.59 3 1.501A3.743 3.743 0 0 1 11.006 1h4.245a.75.75 0 0 1 .75.75v10.5a.75.75 0 0 1-.75.75h-4.507a2.25 2.25 0 0 0-1.591.659l-.622.621a.75.75 0 0 1-1.06 0l-.622-.621A2.25 2.25 0 0 0 5.258 13H.75a.75.75 0 0 1-.75-.75Zm7.251 10.324.004-5.073-.002-2.253A2.25 2.25 0 0 0 5.003 2.5H1.5v9h3.757a3.75 3.75 0 0 1 1.994.574ZM8.755 4.75l-.004 7.322a3.752 3.752 0 0 1 1.992-.572H14.5v-9h-3.495a2.25 2.25 0 0 0-2.25 2.25Z"></path></svg> README] と \[<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-code-of-conduct" aria-label="code-of-conduct" role="img"><path d="M8.048 2.241c.964-.709 2.079-1.238 3.325-1.241a4.616 4.616 0 0 1 3.282 1.355c.41.408.757.86.996 1.428.238.568.348 1.206.347 1.968 0 2.193-1.505 4.254-3.081 5.862-1.496 1.526-3.213 2.796-4.249 3.563l-.22.163a.749.749 0 0 1-.895 0l-.221-.163c-1.036-.767-2.753-2.037-4.249-3.563C1.51 10.008.007 7.952.002 5.762a4.614 4.614 0 0 1 1.353-3.407C3.123.585 6.223.537 8.048 2.24Zm-1.153.983c-1.25-1.033-3.321-.967-4.48.191a3.115 3.115 0 0 0-.913 2.335c0 1.556 1.109 3.24 2.652 4.813C5.463 11.898 6.96 13.032 8 13.805c.353-.262.758-.565 1.191-.905l-1.326-1.223a.75.75 0 0 1 1.018-1.102l1.48 1.366c.328-.281.659-.577.984-.887L9.99 9.802a.75.75 0 1 1 1.019-1.103l1.384 1.28c.295-.329.566-.661.81-.995L12.92 8.7l-1.167-1.168c-.674-.671-1.78-.664-2.474.03-.268.269-.538.537-.802.797-.893.882-2.319.843-3.185-.032-.346-.35-.693-.697-1.043-1.047a.75.75 0 0 1-.04-1.016c.162-.191.336-.401.52-.623.62-.748 1.356-1.637 2.166-2.417Zm7.112 4.442c.313-.65.491-1.293.491-1.916v-.001c0-.614-.088-1.045-.23-1.385-.143-.339-.357-.633-.673-.949a3.111 3.111 0 0 0-2.218-.915c-1.092.003-2.165.627-3.226 1.602-.823.755-1.554 1.637-2.228 2.45l-.127.154.562.566a.755.755 0 0 0 1.066.02l.794-.79c1.258-1.258 3.312-1.31 4.594-.032.396.394.792.791 1.173 1.173Z"></path></svg> 行動基準] の横)
* リポジトリ サイドバーの \[投稿中] リンク

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

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

オーナーおよびコントリビューターの双方にとって、コントリビューションガイドラインは、不適切なプルリクエストや Issue によって引き起こされるリジェクトおよび再提出の手間を省くための有効な手段です。

Organization または個人用アカウント用にデフォルトのコントリビューション ガイドラインを作成できます。 詳しくは、「[既定のコミュニティ正常性ファイルの作成](/ja/enterprise-server@3.20/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)」をご覧ください。

> \[!TIP]
> リポジトリの保守担当者は、そのリポジトリの issue や pull request のテンプレートを作成して、issue についての特定のガイドラインを設定できます。 詳しくは、「[Issueとプルリクエストのテンプレートについて](/ja/enterprise-server@3.20/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)」をご覧ください。

## `CONTRIBUTING.md` ファイルの追加

1. GitHub で、リポジトリのメイン ページに移動します。

2. ファイルの一覧の上にある **\[Add file <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-triangle-down" aria-label="The downwards-facing triangle icon" role="img"><path d="m4.427 7.427 3.396 3.396a.25.25 0 0 0 .354 0l3.396-3.396A.25.25 0 0 0 11.396 7H4.604a.25.25 0 0 0-.177.427Z"></path></svg>]** ドロップダウン メニューを選んでから、**\[<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-plus" aria-label="plus" role="img"><path d="M7.75 2a.75.75 0 0 1 .75.75V7h4.25a.75.75 0 0 1 0 1.5H8.5v4.25a.75.75 0 0 1-1.5 0V8.5H2.75a.75.75 0 0 1 0-1.5H7V2.75A.75.75 0 0 1 7.75 2Z"></path></svg> Create new file]** をクリックします。

   または、左側のファイル ツリー ビューの <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-plus" aria-label="The plus sign icon" role="img"><path d="M7.75 2a.75.75 0 0 1 .75.75V7h4.25a.75.75 0 0 1 0 1.5H8.5v4.25a.75.75 0 0 1-1.5 0V8.5H2.75a.75.75 0 0 1 0-1.5H7V2.75A.75.75 0 0 1 7.75 2Z"></path></svg> をクリックしてもかまいません。

   ![上で説明した \[Add file\] と "プラス記号" アイコンの両方がオレンジ色の枠線で強調されている、リポジトリのメイン ページのスクリーンショット。](/assets/images/help/repository/add-file-buttons.png)

3. リポジトリのルート `docs` または `.github` のディレクトリにコントリビューション ガイドラインを保存するかどうかを決定します。 そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。 コントリビューションガイドラインのファイル名では大文字と小文字は区別されません。 サポートされているファイル拡張子の場合、ファイルはリッチテキスト形式でレンダリングされます。 詳しくは、「[非コード ファイルの操作](/ja/enterprise-server@3.20/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)」をご覧ください。
   * リポジトリのルート ディレクトリにコントリビューション ガイドラインが表示されるようにするには、「*CONTRIBUTING*」と入力します。
   * リポジトリの `docs` ディレクトリにコントリビューション ガイドラインが表示されるようにするには、「*docs/* 」と入力して新しいディレクトリを作成してから、「*CONTRIBUTING*」を入力します。
   * リポジトリに複数の *CONTRIBUTING* ファイルが含まれている場合、リンクに表示されるファイルは、`.github` ディレクトリ、リポジトリのルート ディレクトリ、最後に `docs` ディレクトリの順に選択されます。

4. 新しいファイルに、コントリビューションガイドラインを追加します。 このガイドラインには、次のことを含めましょう:
   * 有意義な Issue やプルリクエストの作成手順
   * \- 外部ドキュメント、メーリングリストや行動規範へのリンク
   * \- コミュニティや行動への期待

5. **\[変更のコミット...]** をクリックします。

6. \[コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「[複数の作成者または組織に代わってコミットを作成する](/ja/enterprise-server@3.20/pull-requests/how-tos/commit-changes/creating-a-commit-with-multiple-authors)」をご覧ください。

7. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「[pull request の作成](/ja/enterprise-server@3.20/pull-requests/how-tos/create-pull-requests/creating-a-pull-request)」をご覧ください。

   ![GitHub pull request のスクリーンショット。メイン ブランチに直接コミットする、または新しいブランチを作成するためのラジオ ボタンが表示されています。 新しいブランチが選択されています。](/assets/images/help/repository/choose-commit-branch.png)

8. **\[変更のコミット]** または **\[変更の提案]** をクリックします。

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

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

* GitHub Docs貢献[ガイドライン](/ja/enterprise-server@3.20/contributing)。
* Ruby on Rails の[コントリビューション ガイドライン](https://github.com/rails/rails/blob/main/CONTRIBUTING.md)。
* Open Government の[コントリビューション ガイドライン](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md)。

## 参考資料

* オープン ソース ガイドの「オープン ソース プロジェクトの開始」セクション
* [GitHub Skills](https://skills.github.com/)
* [リポジトリへのライセンスの追加](/ja/enterprise-server@3.20/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)