1. README.md
- 目的: プロジェクトの概要、使い方、インストール方法など、プロジェクトの基本情報を伝える。
- 内容: プロジェクトの説明、使い方、スクリーンショットやGIF、ライセンス情報など。
2. .gitignore
- 目的: Gitでトラックしたくないファイルやディレクトリを指定する。
- 内容: 例) ビルド結果、一時ファイル、センシティブな情報など。
3. LICENSE
- 目的: プロジェクトのライセンス情報を明示する。
- 内容: GPL, MIT, Apacheなど、適切なオープンソースライセンスのテキスト。
4. CONTRIBUTING.md
- 目的: 他の開発者がプロジェクトに貢献する際のガイドラインを提供する。
- 内容: 貢献の手順、コードのスタイルガイド、テストの実行方法など。
5. CODE_OF_CONDUCT.md
- 目的: コミュニティの行動規範を設定する。
- 内容: プロジェクトへの参加者間の予期される行動や、不適切な行動への対応策など。
6. .github/ディレクトリ
- 目的: GitHubの特定の機能や設定を管理する。
-
内容:
-
ISSUE_TEMPLATE/: イシュー作成時のテンプレート。 -
PULL_REQUEST_TEMPLATE.md: プルリクエスト作成時のテンプレート。
-
7. CHANGELOG.md
- 目的: バージョンごとの変更履歴をトラッキングする。
- 内容: 新機能、変更点、バグ修正、非推奨となった機能のリストなど。
8. SECURITY.md
- 目的: セキュリティ上の問題を報告するためのガイドラインを提供する。
- 内容: 問題の報告方法、脆弱性への対応策の公表タイミングなど。