このページでわかること
README、changelog、release noteの役割分担と、Codexで整える時の注意点がわかります。
結論
CodexにGitHub実務を任せる時は、対象repo、branch、差分、Secrets、CI、PR本文を分けて確認します。main直push、危険操作、テスト無効化、private repoなら安全という考え方は避けます。
対象読者
CodexでGitHubのIssue、PR、レビュー、CI、branch、private repo、READMEやrelease noteを扱いたい人向けです。
Codexに任せやすいこと
変更点の分類、日付整理、README構成、release note下書き、未確認情報の抽出。
人間が確認すべきこと
内部事情、未公開情報、Secrets、未確認機能、誇大表現が入っていないか。
GitHub作業での注意点
READMEは初見向け、changelogは変更履歴、release noteは利用者向け説明として分けます。
やってはいけないこと
危険コマンド、force pushの安易な推奨、テスト無効化、Secretsやtokenのログ出力、社内コードや顧客情報の入力推奨は避けます。
STOP条件
未確認機能を最新扱いする必要がある、秘密情報や社内事情が入る、公式発表のように見える場合。
FAQ
READMEとchangelogは同じですか？
違います。READMEは初見向け、changelogは変更履歴です。
release noteには何を書きますか？
利用者に関係する変更、注意点、確認日、既知の制限を書きます。
内部事情を書いてよいですか？
基本的に避けます。公開してよい情報だけにします。
Codexに全部任せてよいですか？
下書きは任せられますが、公開範囲と事実確認は人間が見ます。