GitHub 中的 Codex 程式碼審查

Codex 程式碼審查會檢查 pull request diff，遵循儲存庫中的指導，併發布一條標準 GitHub 程式碼審查，重點關注嚴重問題。

概覽影片：Codex 程式碼審查演示

開始之前

請先確認：

• 目標儲存庫已經設定好 Codex 雲端。
• 你可以存取 Codex code review settings。
• 如果希望 Codex 遵循儲存庫級審查指導，請準備好 AGENTS.md。

設定 Codex 程式碼審查

1. 先設定好 Codex 雲端。
2. 開啟 Codex 設定。
3. 為你的儲存庫啟用 Code review（程式碼審查）。

請求一次 Codex 審查

1. 在 pull request 評論中輸入：

   @codex review

2. 等待 Codex 先做出 👀 反應，然後釋出審查結果。

Codex 會像隊友一樣，直接在 pull request 上釋出一條審查。在 GitHub 中，Codex 只標記 P0 和 P1 級問題，因此審查評論會聚焦高優先順序風險。

啟用自動審查

如果你希望 Codex 自動審查每一個 pull request，請在 Codex 設定 中啟用 Automatic reviews（自動審查）。這樣每當有人開啟新的 PR 供審查時，Codex 都會自動釋出審查，而不需要額外的 @codex review 評論。

自定義 Codex 的審查重點

Codex 會在儲存庫中搜索 AGENTS.md，並遵循適用的程式碼審查規則。請在最靠近規則所轄程式碼的檔案中新增 ## Code Review Rules 章節；需要時可用 ### 標題為相關檢查分組。

例如，實驗報告服務可以通過下面的規則，避免暴露後的行為改變對比佇列：

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

儲存庫級規則放在根目錄 AGENTS.md 中，服務專屬規則則放在巢狀檔案中，例如 services/experiment_reporting/AGENTS.md。Codex 會對每個已改動檔案應用根目錄規則以及覆蓋該檔案的更具體規則，因此無關變更不必攜帶服務專屬上下文。

可以先寫兩三條簡潔規則，固化審查者經常解釋的檢查。合適的規則包括：

• 聚焦會造成後果、且與儲存庫相關的行為。 說明需要標記的相容性約束、資料邊界或不安全副作用，以及其影響。
• 給出安全做法或例外。 提供足夠上下文，讓 Codex 區分真實問題與預期行為。
• 保持範圍明確、規則耐久。 優先描述結果，而不是可能變化的函式名；並把指導放在靠近所轄程式碼的位置。
• 把機械檢查交給 CI。 格式、lint 等確定性檢查不應寫進審查規則。

開啟一個有代表性的 pull request，通過 @codex review 請求審查。根據發現和回饋迭代規則，並收緊或刪除會產生噪聲的指導。

程式碼審查規則用於指導 Codex，但不能替代測試、分支保護或必需審批。

如果只是一次性的審查重點，可以直接寫在 pull request 評論裡：

@codex review for security regressions

處理審查發現

Codex 釋出審查後，你可以繼續在同一個 pull request 中留言，讓它修復問題：

@codex fix the P1 issue

Codex 會以該 pull request 為上下文啟動一個雲端聊天；如果它有權限，也可以把修復推回到當前分支。

給 Codex 其他任務

如果你在評論裡提到 @codex，但後面跟的不是 review，Codex 就會使用當前 pull request 作為上下文，發起一個雲端聊天。

@codex fix the CI failures

排查程式碼審查

如果 Codex 沒有反應或沒有釋出審查：

• 確認你已經在 Codex 設定中為該儲存庫啟用 Code review（程式碼審查）。
• 確認該 pull request 屬於已經設定 Codex 雲端 的儲存庫。
• 在 pull request 評論中使用精確觸發詞 @codex review。
• 對於自動審查，確認你已經啟用 Automatic reviews（自動審查），並且 pull request 事件匹配你的審查觸發設定。

來源：</zh-TW/docs/third-party/github> 更新時間：2026-07-10（UTC）