GitHubのRepository上で確認可能な「説明タブ」について少し調べたことをまとめます。
ここでいう説明タブとはGitHub上のRepositoryに表示される「README」などのタブです。
タブ表示はわかりやすいし変更もすぐに出来るんですよね。
現在サポートされているタブ
2024年時点、
- README
- Code of conduct
- MIT license（＊）
- Security
だけのようです。
タブを表示させる方法
リポジトリ直下にファイルを配置するだけです。
| タブ名 | ファイル名 | 概要 |
|---|---|---|
| README | README.md | そのプロジェクトがなぜ有益なのか、そのプロジェクトで何ができるか、そのプロジェクトをどのように使えるかを他者に伝えるましょう！ |
| Code of conduct | CODE_OF_CONDUCT.md | コミュニティへの参加方法に関する基準を定義 |
| MIT license (＊） | LICENSE | リポジトリのライセンス |
| Security | SECURITY.md | プロジェクト内のセキュリティ脆弱性を報告する方法と、ファイルにハイパーリンクする説明が記載 |
◇ ファイル説明に関するページ
Creating a default community health file - GitHub Docs
You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for ...
docs.github.com
- Q４種類以上は表示できないのかな？
- A
現時点は出来ないようです。
例えば、CONTRIBUTING.md、CHANGELOG.mdなどは出来ません。手動設定も出来ません。
コメント