.githubリポジトリにリポジトリ間で共有するファイルを配置する

[fkoyama]

概要

Organization 配下のリポジトリに行動規範等の該当ファイルが存在しない場合、 .github リポジトリ内の該当ファイルを利用することができます。
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

.github リポジトリを作成し、リポジトリ間で共有するファイルを配置することで管理しやすくします。

詳細 / 機能詳細（オプション）

• ファイル配置案
  • .github リポジトリに配置するファイル
    • Pull Request Template
    • CODE_OF_CONDUCT
      • 違反報告フォームを共通化し、URL差し替え
    • Issue Template
      • Discussions, Issues, Pull requests, Open a draft security advisory のリンクを相対パスに変更
      • 行動規範のリンク先を .github リポジトリ内の行動規範に変更
  • 個別リポジトリに配置するファイル
    • LICENSE
    • CONTRIBUTING

完了条件

• .github リポジトリにリポジトリ間で共有するファイルが追加されていること
• 必要に応じてファイルが maris リポジトリと maia リポジトリから削除/修正されていること

[fkoyama]

.github リポジトリの動作確認

• .github リポジトリで対応しているデフォルトファイルの種類
  https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types
  ※ README, LICENSE ファイルは未対応

  • 個別リポジトリ内に該当ファイルが存在する場合は個別リポジトリ内のファイルが優先される
    • e.g.
      .github リポジトリ内のファイル：CODE_OF_CONDUCT, SECURITY
      repo1 リポジトリ内のファイル：SECURITY
      ⇒ repo1で利用されるファイル：.github の CODE_OF_CONDUCT & repo1 の SECURITY

• リポジトリのトップ画面に表示されるファイル : CODE_OF_CONDUCT, SECURITY

  • 個別リポジトリ内に該当ファイルが存在しない場合、.github リポジトリ内の該当ファイルが個別リポジトリのトップ画面に表示される
  • 各ファイルに記載の相対パスリンクは、リンクが記載されているファイルを起点にしている
    • e.g.
      .github リポジトリ内のファイル：CODE_OF_CONDUCT, SECURITY
      repo1 リポジトリ内のファイル：SECURITY
      ⇒ repo1で CODE_OF_CONDUCT に記載の相対パスリンク ./SECURITY.md にアクセスすると.githubのSECURITYに遷移
    • e.g.
      .github リポジトリ内のファイル：CODE_OF_CONDUCT
      repo1 リポジトリ内のファイル：SECURITY
      ⇒ repo1でCODE_OF_CONDUCT に記載の相対パスリンク ./SECURITY.md にアクセスすると 404 が返る

• Issue Template, config.yml

  • 個別リポジトリ側にファイルが存在する場合は個別リポジトリ側のファイルの設定のみ適用される
    ※個別リポジトリで設定したテンプレートに追加で .github リポジトリのテンプレートが表示されることはない
  • Issues, Pull Request, Open security advisory, リポジトリトップ画面の行動規範には以下の相対パスでアクセスできる
    (Issue作成画面を起点とした相対パス)

 [Open a draft security advisory](../security/advisories/new)
 [Issues](../issues) 
 [Discussions](../discussions)
 [行動規範](../?tab=coc-ov-file)

• Pull Request Template

  • 個別リポジトリ側にファイルが存在する場合は個別リポジトリ側のファイルの設定が適用される

• Discussion category forms

  • テンプレートのファイル名とDiscussions上のカテゴリー名を同じにする必要がある(日本語名は非対応)
  • 個別リポジトリ側にファイルが存在する場合は個別リポジトリ側のファイルの設定のみ適用される
    ※個別リポジトリで設定したテンプレートに追加で .github リポジトリのテンプレートが表示されることはない