🟤
my備忘用：README.md と GitHubリポジトリ
いい感じのリポジトリの維持のために
コードレビュー
いうまでもなく必須
ブランチの保護
ブランチプロテクションルールを指定して、大事なブランチにヒューマンエラー（ブランチ削除や、レビューなしのマージ etc.）の混入を防ぐ。
README.md
基本情報
- Overview
- 目的や用途、存在意義など
- Setup
- 使用のために必要な準備事項、インストール方法など
- How to use
- 簡易な使い方の説明、よくあるパターン紹介など
- refrence
- ライセンスやコントリビューティング、リリースノートなど
開発者向け情報
- 全体構成・設計
- アーキテクチャ、画面遷移図、連携サードパーティなど
- 環境構築
- 開発作業をするための準備事項
- 開発方法
- コンパイルやリンター、テストの方法
- リリース関連
- リリースプロセスやリリース後の確認事項
- 相談窓口
- コードオーナーやトラブル発生時の連絡先など
ライセンス
パブリックリポジトリを利用する場合は、LICENSEファイルを配置し、コードの利用や変更、再配布の条件などのライセンス情報を残す。免責事項なども記載し、法的な位置付けを明記する。
基本的に、権利を強く主張すつもりがないなら、MIT Licenseで良い。
Community health files
Creating a default community health file
CONTRIBUTING.md
オープンソースプロジェクトにおけるコントリビューター向けのガイドラインを提供するための文書。
プロジェクトのルートディレクトリに配置し、コントリビューターがどのようにプロジェクトに貢献できるかを明確する。
これにより、貢献プロセスがスムーズになり、貢献の質を向上させることができる。
CODE_OF_CONDUCT.md
オープンソースプロジェクトにおける参加者全員の行動基準を定めた文書。
このファイルは、プロジェクトのルートディレクトリに配置し、プロジェクトに関わるすべての人々（コントリビューター、メンテナー、ユーザーなど）がどのように振る舞うべきかを明示する。
これにより、プロジェクト内でのコミュニケーションや協力が円滑に行われ、健全なコミュニティが形成されることを目指す。
SECURITY.md
ソフトウェアプロジェクトにおけるセキュリティに関するガイドラインを提供するための文書。
このファイルは、プロジェクトのルートディレクトリに配置し、プロジェクトのセキュリティ関連の手順、ポリシー、報告方法を明確にする。
これにより、セキュリティ脆弱性が発見された場合に迅速かつ適切な対応ができるようになる。
Discussion