ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

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

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

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

プロジェクトコントリビューターにうまく作業してもらうために、プロジェクトリポジトリのルート、docs または .github フォルダに、コントリビューションガイドラインについてのファイルを追加できます。 プルリクエストをオープンした場合や Issue を作成した場合、そのファイルへのリンクが表示されます。 コントリビューションガイドラインへのリンクは、リポジトリの contribute ページにも表示されます。 contributeページの例についてはgithub/docs/contributeを参照してください。

contributing-guidelines

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

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

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

Organization またはユーザアカウント用のデフォルトのコントリビューションガイドラインを作成できます。 詳しい情報については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

ヒント: リポジトリメンテナは、リポジトリの Issue やプルリクエストのテンプレートを作成することで、Issue についての特定のガイドラインを定めることができます。 詳しい情報についてはIssue およびプルリクエストのテンプレートについてを参照してください。

CONTRIBUTING ファイルの追加

  1. your GitHub Enterprise Server instanceで、リポジトリのメインページにアクセスしてください。
  2. ファイルのリストの上で、Add file(ファイルの追加)ドロップダウンを使い、Create new file(新規ファイルの作成をクリックしてください。 "ファイルの追加"ドロップダウン内の"新規ファイル作成"
  3. コントリビューションガイドラインを、リポジトリの root、docs、または .github ディレクトリに保管するかどうかを決めます。 そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。 コントリビューションガイドラインのファイル名では大文字と小文字は区別されません。 サポートされているファイル拡張子の場合、ファイルはリッチテキスト形式でレンダリングされます。 For more information, see "Working with non-code files." 新しいファイルの名前
    • リポジトリのルートディレクトリでコントリビューションガイドラインを表示するには、CONTRIBUTING と入力します。
    • リポジトリの docs ディレクトリにコントリビューションガイドラインを表示するには、docs/ と入力して新しいディレクトリを作成し、次に CONTRIBUTING と入力します。
    • リポジトリに複数の CONTRIBUTING ファイルが含まれている場合、リンクに表示されるファイルは、.github ディレクトリ、リポジトリのルートディレクトリ、最後に docs ディレクトリの順に選択されます。
  4. 新しいファイルに、コントリビューションガイドラインを追加します。 このガイドラインには、次のことを含めましょう:
    • 有意義な Issue やプルリクエストの作成手順
      • 外部ドキュメント、メーリングリストや行動規範へのリンク
      • コミュニティや行動への期待
  5. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。 変更のコミットメッセージ
  6. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しい情報については「新しいプルリクエストの作成」を参照してください。 コミットブランチのオプション
  7. Propose new file(新規ファイルの提案)をクリックしてください。 新規ファイルの提案ボタン

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

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

参考リンク

このドキュメントは役立ちましたか?

プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?