GitHub READMEの書き方
READMEは、リポジトリを開いた人が最初に読む説明書です。何のプロジェクトか、どう使うか、注意すべきことを短く整理します。
このページでわかること
- プロジェクト概要と目的を書く
- 使い方と必要環境を分ける
- 注意事項とlicenseへの導線を置く
まず確認すること
- 内部サーバーパスや認証情報を書かない
- 個人情報や連絡先を出しすぎない
- 更新履歴や問い合わせ範囲を明確にする
やってはいけないこと
- Secretsや内部情報を例として載せる
- 公式と誤解される表現を使う
- 未確認の利用条件を断定する
安全寄りに進める手順
- 対象のrepo、branch、PR、Actions runを確認する。
- Secrets、APIキー、token、.env、個人情報が差分やログに出ていないか見る。
- 必要な場合は値を停止または再発行し、影響範囲を整理する。
- 変更は小さなbranchとPRに分け、CIとreviewで確認する。
CodexやAI作業時の注意
AIに作業を渡す時は、対象ファイル、触らないファイル、確認項目を明記します。認証情報や実際のキー値は本文、Issue、PR説明、ログ、レポートに残さないようにします。
公式情報で確認する領域
Actions、Secrets、PR、repository visibility、workflow permissionsは仕様が変わることがあります。実作業前にはGitHub Docsで最新の説明を確認してください。