【トラブル】【Github】.github 直下に README.md を置いたらリポジトリルートに表示

■ はじめに

小ネタ。

GithubのREADME.md で意図しない動きだったのでメモ。

【１】現象

以下「１）フォルダ構成」のように、README.md を置いたら
.github 直下に README.md がリポジトリルートに表示された

１）フォルダ構成

+ README.md
+ .github
  + README.md << こっちが表示

【２】原因

* どうも、この動きは仕様らしい

仕様記述箇所
https://docs.github.com/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes#about-readmes

より抜粋
~~~~~~~~~~~~~~~
README ファイルをリポジトリの隠れ .github ルート
または docs ディレクトリに置けば、GitHub はそれを認識して
自動的に README をリポジトリへの訪問者に提示します。

★注目★
リポジトリに複数の README ファイルが含まれている場合、
表示されるファイルは、
.github ディレクトリ、
リポジトリのルート ディレクトリ、
最後に docs ディレクトリ
の順に選択されます。
~~~~~~~~~~~~~~~

【３】解決案

* .github配下の別の場所（例えば、.github/workflows 直下）に
　README.md に移動する

【修正前】フォルダ構成

+ README.md
+ .github
  + README.md

【修正後１】フォルダ構成

+ README.md
+ .github
  + workflows
      + README.md << .github/workflows 直下に移動

【修正後２】フォルダ構成

+ README.md
+ .github
  + docs
      + README.md << .github/docs 直下に移動 (こっちでも大丈夫だった)

関連記事

Github ～ 入門編 ～
https://dk521123.hatenablog.com/entry/2019/07/18/234652
Github ～ README.md の書き方 ～
https://dk521123.hatenablog.com/entry/2020/04/10/173658