コントリビューションガイドラインについて
プロジェクトコントリビューターにうまく作業してもらうために、プロジェクトリポジトリのルート、docs または .github フォルダに、コントリビューションガイドラインについてのファイルを追� できます。 プルリクエストをオープンした� �合や Issue を作成した� �合、そのファイルへのリンクが表示されます。 コントリビューションガイドラインへのリンクは、リポジトリの contribute ページにも表示されます。 contributeページの例についてはgithub/docs/contributeを参照してく� さい。
リポジトリのオーナーにとって、コントリビューションガイドラインとは、人々がどのようにコントリビュートするべきかを伝える方法です。
コントリビューターにとって、このガイドラインは、上手に構築されたプルリクエストの提出をしたり、有益な Issue をオープンすることの確認に役立ちます。
オーナーおよびコントリビューターの双方にとって、コントリビューションガイドラインは、プルリクエストや Issue のリジェクトや再提出の手間を未然に軽減するための有効な手段です。
Organization またはユーザアカウント用のデフォルトのコントリビューションガイドラインを作成できます。 詳しい情� �については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してく� さい。
ヒント: リポジトリメンテナは、リポジトリの Issue やプルリクエストのテンプレートを作成することで、Issue についての特定のガイドラインを定めることができます。 詳しい情� �についてはIssue およびPull Requestのテンプレートについてを参照してく� さい。
CONTRIBUTING ファイルの追�
- your GitHub Enterprise Server instanceで、リポジトリのメインページにアクセスしてく� さい。
- ファイルのリストの上で、Add file（ファイルの追� ）ドロップダウンを使い、Create new file（新規ファイルの作成をクリックしてく� さい。
- コントリビューションガイドラインを、リポジトリの root、
docs、または.githubディレクトリに保管するかどうかを決めます。 そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。 コントリビューションガイドラインのファイル名では大文字と小文字は区別されません。 サポートされているファイル拡張子の� �合、ファイルはリッチテキスト形式でレンダリングされます。 For more information, see "Working with non-code files."
- リポジトリのルートディレクトリでコントリビューションガイドラインを表示するには、CONTRIBUTING と入力します。
- リポジトリの
docsディレクトリにコントリビューションガイドラインを表示するには、docs/ と入力して新しいディレクトリを作成し、次に CONTRIBUTING と入力します。 - リポジトリに複数の CONTRIBUTING ファイルが含まれている� �合、リンクに表示されるファイルは、
.githubディレクトリ、リポジトリのルートディレクトリ、最後にdocsディレクトリの� �に選択されます。
- 新しいファイルに、コントリビューションガイドラインを追� します。 このガイドラインには、次のことを含めましょう:
- 有意義な Issue やプルリクエストの作成手� �
-
- 外部ドキュメント、メーリングリストや行動規範へのリンク
-
- コミュニティや行動への期待
- ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してく� さい。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情� �については「複数の共作者を持つコミットの作成」を参照してく� さい。
- コミットメッセージフィールドの下で、コミットを追� を現在のブランチか新しいブランチから選択してく� さい。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しい情� �については「新しいプルリクエストの作成」を参照してく� さい。
- Propose new file（新規ファイルの提案）をクリックしてく� さい。
コントリビューションガイドラインの例
最初は悩むかもしれませんが、以下のコントリビューションガイドラインの例を役立ててく� さい:
- Atom エディタ コントリビューションガイドライン。
- Ruby on Rails コントリビューションガイドライン.
- オープンガバメント コントリビューションガイドライン.
参考リンク
- オープンソースガイドのセクション「オープンソースプロジェクトを始める」
- 「リポジトリへのライセンスの追� 」