リポジトリコントリビューターのためのガイドラインを定める
プロジェクトに人々がどのようにコントリビュートするべきかを伝えるガイドラインを作成できます。
ここには以下の内容があります:
プロジェクトコントリビューターにうまく作業してもらうために、プロジェクトリポジトリのルート、docs または .github フォルダに、コントリビューションガイドラインについてのファイルを追加できます。 プルリクエストをオープンした場合や Issue を作成した場合、そのファイルへのリンクが表示されます。
リポジトリのオーナーにとって、コントリビューションガイドラインとは、人々がどのようにコントリビュートするべきかを伝える方法です。
コントリビューターにとって、このガイドラインは、上手に構築されたプルリクエストの提出をしたり、有益な Issue をオープンすることの確認に役立ちます。
オーナーおよびコントリビューターの双方にとって、コントリビューションガイドラインは、プルリクエストや Issue のリジェクトや再提出の手間を未然に軽減するための有効な手段です。
参考: リポジトリメンテナは、リポジトリの Issue やプルリクエストのテンプレートを作成することで、Issue についての特定のガイドラインを定めることができます。 詳しい情報についてはIssue およびプルリクエストのテンプレートについてを参照してください。
CONTRIBUTING ファイルの追加
-
GitHub Enterpriseで、リポジトリのメインページにアクセスしてください。
-
ファイルの一覧の上にある Create new file（新規ファイルの作成）をクリックしてください。
-
コントリビューションガイドラインを、リポジトリの root、
docs、または.githubディレクトリに保管するかどうかを決めます。 そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。 コントリビューションガイドラインのファイル名は大文字と小文字が区別されません。拡張子は .md や .txt などです。
- リポジトリのルートディレクトリでコントリビューションガイドラインを表示するには、CONTRIBUTING と入力します。
- To make your contributing guidelines visible in the repository's
docsdirectory, type docs/ to create the new directory, then CONTRIBUTING.
-
新しいファイルに、コントリビューションガイドラインを追加します。 このガイドラインには、次のことを含めましょう:
- 有意義な Issue やプルリクエストの作成手順
-
- 外部ドキュメント、メーリングリストや行動規範へのリンク
-
- コミュニティや行動への期待
-
ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。
-
コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチが
masterであれば、コミット先として新しいブランチを作成することを選択し、続いてプルリクエストを作成しなければなりません。 詳しい情報については「新しいプルリクエストの作成」を参照してください。
-
Propose new file（新規ファイルの提案）をクリックしてください。
コントリビューションガイドラインの例
最初は悩むかもしれませんが、以下のコントリビューションガイドラインの例を役立ててください:
- Atom エディタ コントリビューションガイドライン。
- Ruby on Rails コントリビューションガイドライン.
- オープンガバメント コントリビューションガイドライン.
参考リンク
- オープンソースガイドのセクション「オープンソースプロジェクトを始める」
- リポジトリへのライセンスの追加