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

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

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

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

contributing-guidelines

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

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

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

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

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

CONTRIBUTING ファイルの追加

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

  2. ファイルリストの上にある [Create new file(新しいファイルを作成)] をクリックします。

    新しいファイル ボタン

  3. コントリビューションガイドラインを、リポジトリの root、docs、または .github ディレクトリに保管するかどうかを決めます。 そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。 コントリビューションガイドラインのファイル名は大文字と小文字が区別されません。拡張子は .md.txt などです。

    新しいファイルの名前

    • リポジトリのルートディレクトリでコントリビューションガイドラインを表示するには、CONTRIBUTING と入力します。
    • To make your contributing guidelines visible in the repository's docs directory, type docs/ to create the new directory, then CONTRIBUTING.
  4. 新しいファイルに、コントリビューションガイドラインを追加します。 このガイドラインには、次のことを含めましょう:

    • 有意義な Issue やプルリクエストの作成手順
      • 外部ドキュメント、メーリングリストや行動規範へのリンク
      • コミュニティや行動への期待
  5. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。

    変更のコミットメッセージ

  6. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが master なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。

    Commit branch options

  7. [Propose new file(新しいファイルを提案)] をクリックしてください。

    Propose new file ボタン

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

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

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください