ドキュメント & README
プロジェクトのインストール方法、実行方法、設定方法、利用方法に影響を与える変更があった場合は、同じ変更内で README.md を更新してください。
READMEには、以下の内容を簡潔に記載する必要があります。
- プロジェクトの説明(1-2文)
- 要件とインストール手順
- 実行方法、テスト方法、ビルド方法 — コピー&ペースト可能なコマンド
- 設定: すべての環境変数について、目的とサンプル値(実際の秘密情報は含めないこと)
- 主要機能の簡単な使用例
ルール:
- 変更が影響するセクションのみを編集すること。ファイル全体を書き換えないこと。
- ドキュメント内のすべてのコマンドが実際に動作することを確認すること。
- 英語を使用し、短い文章で、マーケティング用の表現は避けること。