目次の追加による Readme.md 見通し改善案

[rigaya]

変更の種類

• 不具合の修正
• 新しい機能の追加
• 改善・リファクタリング（機能は追加されないが、動作やコードを改善する破壊的でない変更）

チェックリスト:

• 開発資料 と データベース設計 は読みましたか？
  • もともと自分用のメモですが、このプロジェクトの開発方針や設計などが記載されています。開発時の参考にしてください。
• Git のコミットメッセージは開発資料に記載のフォーマットになっていますか？（重要）
  • このプロジェクト上のコミットメッセージは、基本的に全てこのフォーマットに従って記述されています（文字数は問いません）。
  • 正しいフォーマットになっていない場合、force push で必ずコミットメッセージを変更してから送信してください。
• このプロジェクトのコーディング規約に従ったコードになっていますか？
  • コーディング規約は開発資料に記載されています。
  • そもそもコーディング規約と言えるほど大層なものではありませんが、一度目を通しておいてください。
• プルリクエストは master ブランチに送信されていますか？
  • release ブランチはリリースした時にしか更新されません。必ず master ブランチに送信してください。

説明

Readme.md にリンク付き目次を追加します(表示例)。

この目次は、VSCode の Markdown All in One の Create Table of Contents (TOC) 機能により自動生成したものです。 Readme.md を保存する際、自動で更新されます。

動機とコンテキスト

Readme の見通しを(ある程度)改善し、また目次リンクから該当箇所に飛ぶことができるようになり、ユーザーが探している情報にアクセスしやすくなることが期待されます。

自動生成のため、今後のメンテナンスの手間も最小限にすることができると思います。
逆に細かい調整等は効かない、しないほうが良いと思うので、そのあたりいまいち思想に合わない場合は、マージせず Close してしまってください。

[tsukumijima]

目次に関しては画像の通り GitHub 側の機能があるしなくてもいいかな…と思って以降考えもしていなかったのですが、表示例を見る限り、かなりドキュメント全体の見通しが良くなってよさそうです。この GitHub 側の機能自体目立たないのであまり使われてなさそうなのもあります。
マージさせていただきます！この度はありがとうございました！🙏

[rigaya]

すみません、github 側の機能については、失念していました。

ただ、目次全体を直接表示したほうが、おっしゃる通り見通しがよくなるかと思います。マージいただき、ありがとうございました。