プロジェクトへのサポートリソースの追加

SUPPORT ファイルを作成して、プロジェクトについての支援を得る方法を知らせることができます。

特定のサポート リソースにユーザーを誘導するために、リポジトリのルート、docs または .github のフォルダーに SUPPORT ファイルを追加できます。 誰かがリポジトリに Issue を作成すると、その人はプロジェクトの SUPPORT ファイルへのリンクを見ることになります。

新しい issue フォームのスクリーンショット。 右サイドバーの [役に立つリソース] セクションで、[サポート] というラベルのリンクが濃いオレンジ色の枠線で囲まれています。

Organization または個人用アカウントの既定のサポート リソースを作成できます。 詳しくは、「既定のコミュニティ正常性ファイルの作成」をご覧ください。

Tip

サポート ガイドラインを見つけやすくするために、Readme ファイルなどのリポジトリ内の他の場所から SUPPORT ファイルにリンクできます。

プロジェクトへのサポートリソースの追加

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

  2. ファイル リストの上にある [Add file ] ドロップダウン メニューを選んで、[ Create new file] をクリックします。

    または、左側のファイル ツリー ビューの をクリックしてもかまいません。

    リポジトリのメイン ページのスクリーンショット。 ファイルの一覧の上には、[ファイルの追加] というラベルが付いたボタンが濃いオレンジ色の枠線で囲まれています。 リポジトリのファイル ツリー ビューでは、+ アイコンが付いたボタンも濃いオレンジ色で囲まれています。

  3. [ファイル名] フィールドに「SUPPORT.md」 (すべて大文字) と入力します。

  4. [新しいファイルの編集] タブで、ユーザーがプロジェクトについてのサポートを得る方法に関する情報を追加します。

  5. SUPPORT ファイルを確認するには、 [プレビュー] をクリックします。

  6. [変更のコミット...] をクリックします。

  7. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」を参照してください。

  8. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」を参照してください。

    GitHub pull request のスクリーンショット。メイン ブランチに直接コミットする、または新しいブランチを作成するためのラジオ ボタンが表示されています。 新しいブランチが選ばれています。

  9. [変更のコミット] または [変更の提案] をクリックします。