行動規範は、コミュニティへの参加方法の標準を定義するものです。 それは、すべてのコントリビューションを尊重する開放的な環境であることを発信します。 また、プロジェクトのコミュニティのメンバー間の問題に対処するための手順の概要も示します。 行動規範がコミュニティへの参加方法についての標準と期待を定義する理由に関して、詳しい情報についてはオープンソースガイドを参照してください。
プロジェクトで行動規範を採択する前に:
- オープンソースプロジェクト用に策定されたさまざまな行動規範をリサーチする。 自分のコミュニティの標準を反映しているものを選択してください。
- それを適用したいか、そして適用できるのかを注意深く検討してください。
テンプレートを使用するか、手動でカスタムの行動規範を作成して、プロジェクトに行動規範を追加できます。 行動規範はどちらの方法でも利用できますが、「行動規範」はテンプレートを使用する場合にのみ、リポジトリのコミュニティプロフィールで完了としてマークされます。 他者または Organization が作成した行動規範を使用する場合は、必ずソースからの帰属ガイドラインに従ってください。 コミュニティプロフィールの詳細については、「パブリックリポジトリのコミュニティプロフィールについて」を参照してください。
Organization またはユーザアカウント用にデフォルトの行動規範を作成できます。 詳しい情報については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してください。
テンプレートを使用して行動規範を追加する
プロジェクトに素早く行動規範を追加できるよう、GitHubでは一般的な行動規範のテンプレートが用意されています。
- GitHub.comで、リポジトリのメインページにアクセスしてください。
- ファイルのリストの上で、Add file（ファイルの追加）ドロップダウンを使い、Create new file（新規ファイルの作成をクリックしてください。
- ファイル名のフィールドに CODE_OF_CONDUCT.md と入力します。
- [Choose a code of conduct template] をクリックします。
- ページの左側でプレビューしたい行動規範を選択し、プロジェクトに追加してください。
- ページの右側でフィールドに記入し、適切な情報と共に選択した行動規範を作成してください。
- [Review and submit] をクリックします。
- テキスト領域内にある行動規範の内容をレビューしてください。
- ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。
- コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しい情報については「新しいプルリクエストの作成」を参照してください。
- Propose new file（新規ファイルの提案）をクリックしてください。
行動規範を手動で追加する
提供されているテンプレートで必要な行動規範が利用できない場合は、行動規範を手動で追加できます。
- GitHub.comで、リポジトリのメインページにアクセスしてください。
- ファイルのリストの上で、Add file（ファイルの追加）ドロップダウンを使い、Create new file（新規ファイルの作成をクリックしてください。
- ファイル名フィールドに、ファイルの名前と拡張子を入力します。
- 行動規範をリポジトリのルートディレクトリに表示するには、ファイル名フィールドに CODE_OF_CONDUCT と入力します。
- 行動規範をリポジトリの
docsディレクトリに表示するには、docs/CODE_OF_CONDUCT と入力します。 - 行動規範をリポジトリの
.githubディレクトリに表示するには、 .github/CODE_OF_CONDUCT と入力します。
- 新しいファイルに、カスタムの行動規範を追加します。
- ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。
- コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しい情報については「新しいプルリクエストの作成」を参照してください。
- Propose new file（新規ファイルの提案）をクリックしてください。