For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主要導覽
Codex

Codex use case

審查 GitHub Pull Request

在人工審查前發現迴歸與潛在問題。

Difficulty 簡單
Time horizon 5 秒

使用 GitHub 中的 Codex 程式碼審查,直接在 Pull Request 上自動找出迴歸、遺漏的測試與文件問題。

最適合

  • 希望在人工核准合併前取得額外審查訊號的團隊
  • 擁有大型程式碼庫且已在正式環境運作的專案

Contents

    ← 所有使用案例

    審查 GitHub Pull Request

    在人工審查前發現迴歸與潛在問題。

    使用 GitHub 中的 Codex 程式碼審查,直接在 Pull Request 上自動找出迴歸、遺漏的測試與文件問題。

    簡單
    5 秒

    使用 GitHub 中的 Codex 程式碼審查,直接在 Pull Request 上自動找出迴歸、遺漏的測試與文件問題。

    簡單
    5 秒

    最適合

    • 希望在人工核准合併前取得額外審查訊號的團隊
    • 擁有大型程式碼庫且已在正式環境運作的專案

    技能與外掛程式

    Skill Why use it
    Security Best Practices 將審查重點放在機密資訊、身分驗證與相依性變更等高風險面向。

    起始提示詞

    @codex 請審查是否有安全性迴歸、遺漏的測試,以及高風險的行為變更。
    @codex 請審查是否有安全性迴歸、遺漏的測試,以及高風險的行為變更。

    使用方式

    首先,請將 Codex 程式碼審查新增至您的 GitHub 組織或程式碼庫。 如需詳細資訊,請參閱 GitHub 中的 Codex 程式碼審查

    您可以設定 Codex 自動審查每個 Pull Request,也可以在 Pull Request 留言中使用 @codex review 要求審查。

    如果 Codex 指出迴歸或潛在問題,您可以在 Pull Request 留言中加入如 @codex fix it 的後續提示詞,要求它修正問題。

    這會啟動新的雲端對話來修正問題,並更新 Pull Request。

    制定審查指引

    若要自訂 Codex 的審查內容,請將 ## Code Review Rules 區段新增至離規則所適用的程式碼最近的 AGENTS.md。例如:

    ## 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,並將特定服務的規則 放在巢狀檔案中。規則應保持簡潔,並說明要標示的行為,以及任何 安全做法或例外情況;格式化與 lint 檢查則交由 CI 執行。請參閱 自訂 Codex 的審查內容 以了解設定與規則撰寫指引。

    相關使用案例