如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題
Codex

Codex 應用案例

審查 GitHub pull requests

在人工審查前找出回歸問題及其他潛在問題。

難度 Easy
任務時間跨度 5s

在 GitHub 上使用 Codex 審查程式碼,讓 Codex 直接在 pull request 上自動指出回歸問題、測試缺漏與文件問題。

最適合的對象

  • 希望在人工核准合併前多一份審查結果可供參考的團隊
  • 已上線專案的大型程式碼庫

目錄

    ← 所有應用案例

    審查 GitHub pull requests

    在人工審查前找出回歸問題及其他潛在問題。

    在 GitHub 上使用 Codex 審查程式碼,讓 Codex 直接在 pull request 上自動指出回歸問題、測試缺漏與文件問題。

    Easy
    5s

    在 GitHub 上使用 Codex 審查程式碼,讓 Codex 直接在 pull request 上自動指出回歸問題、測試缺漏與文件問題。

    Easy
    5s

    最適合的對象

    • 希望在人工核准合併前多一份審查結果可供參考的團隊
    • 已上線專案的大型程式碼庫

    技能與外掛程式

    • 著重審查風險較高的部分,例如機密資訊的處理、身分驗證及相依套件的變更。
    技能 使用理由
    Security Best Practices 著重審查風險較高的部分,例如機密資訊的處理、身分驗證及相依套件的變更。

    入門提示詞

    @codex review 請檢查是否有安全性回歸問題、測試缺漏或可能帶來風險的行為變更。
    @codex review 請檢查是否有安全性回歸問題、測試缺漏或可能帶來風險的行為變更。

    使用方式

    先在 GitHub 組織或程式碼庫中啟用 Codex 程式碼審查功能。詳情請參閱在 GitHub 上使用 Codex 審查程式碼。

    你可以設定 Codex 自動審查每個 pull request,也可以在 pull request 中留言 @codex review 來要求審查。

    訂定審查規則

    若要自訂 Codex 的審查內容,請將 ## Code Review Rules 區段加到最接近規則所適用程式碼的 AGENTS.md 檔案中。例如:

    ## Code Review Rules
    
    ### 實驗群組
    
    - 比較不同實驗處理的效果時,請勿依曝光後的行為(例如轉換或留存)篩選樣本。
      請依分組結果或曝光紀錄建立群組,並將轉換列為結果指標。

    將適用於整個程式碼庫的規則寫在根目錄的 AGENTS.md 中,個別服務的規則則寫在對應子目錄的檔案中。規則應簡明扼要,說明哪些行為需要標記,以及有哪些安全的做法或例外情況。格式與 lint 檢查交由 CI 執行。如需瞭解如何設定審查及撰寫規則,請參閱自訂 Codex 的審查內容。

    相關應用案例