ai codereviewer

人工智慧程式碼審查員

AI Code Reviewer 是一個 GitHub Action，它利用 OpenAI 的 GPT-4 API 為您的拉取請求提供智慧回饋和建議。這個強大的工具透過自動化程式碼審查流程來幫助提高程式碼品質並節省開發人員的時間。

特徵

• 使用 OpenAI 的 GPT-4 API 審查拉取請求。
• 提供改進程式碼的智慧評論和建議。
• 過濾掉與指定排除模式相符的檔案。
• 易於設定並整合到您的 GitHub 工作流程中。

設定

1. 要使用此 GitHub Action，您需要 OpenAI API 金鑰。如果您沒有，請在 OpenAI 上註冊 API 金鑰。

2. 將 OpenAI API 金鑰新增為儲存庫中的 GitHub Secret，名稱為OPENAI_API_KEY 。您可以在此處找到有關 GitHub Secrets 的更多資訊。

3. 在儲存庫中建立.github/workflows/main.yml檔案並新增以下內容：

 name : AI Code Reviewer

on :
  pull_request :
    types :
      - opened
      - synchronize
permissions : write-all
jobs :
  review :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout Repo
        uses : actions/checkout@v3

      - name : AI Code Reviewer
        uses : your-username/ai-code-reviewer@main
        with :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
          OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL : " gpt-4 " # Optional: defaults to "gpt-4"
          exclude : " **/*.json, **/*.md " # Optional: exclude patterns separated by commas

4. 將your-username替換為您的 GitHub 使用者名稱或 AI Code Reviewer 儲存庫所在的組織名稱。

5. 如果您想要忽略某些文件模式進行審查，請自訂exclude輸入。

6. 將變更提交到您的儲存庫，AI Code Reviewer 將開始處理您未來的拉取請求。

它是如何運作的

AI Code Reviewer GitHub Action 檢索拉取請求差異，過濾掉排除的文件，並將程式碼區塊傳送到 OpenAI API。然後，它根據人工智慧的回應產生審核評論，並將其添加到拉取請求中。

貢獻

歡迎貢獻！請隨時提交問題或拉取請求以改進 AI Code Reviewer GitHub Action。

讓維護者產生最終的套件（ yarn build和yarn package ）。

執照

該項目已獲得 MIT 許可證的許可。有關詳細信息，請參閱許可證文件。