ai codereviewer

AI 코드 검토자

AI Code Reviewer는 OpenAI의 GPT-4 API를 활용하여 끌어오기 요청에 대한 지능형 피드백과 제안을 제공하는 GitHub Action입니다. 이 강력한 도구는 코드 검토 프로세스를 자동화하여 코드 품질을 향상시키고 개발자의 시간을 절약하는 데 도움이 됩니다.

특징

• OpenAI의 GPT-4 API를 사용하여 풀 요청을 검토합니다.
• 코드 개선을 위한 지능적인 설명과 제안을 제공합니다.
• 지정된 제외 패턴과 일치하는 파일을 필터링합니다.
• GitHub 워크플로에 쉽게 설정하고 통합할 수 있습니다.

설정

1. 이 GitHub Action을 사용하려면 OpenAI API 키가 필요합니다. API 키가 없다면 OpenAI에서 API 키를 등록하세요.

2. OpenAI API 키를 이름이 OPENAI_API_KEY 인 저장소에 GitHub 비밀로 추가합니다. 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 코드 검토자 GitHub 작업은 풀 요청 차이점을 검색하고, 제외된 파일을 필터링하고, 코드 청크를 OpenAI API로 보냅니다. 그런 다음 AI의 응답을 기반으로 검토 의견을 생성하고 이를 끌어오기 요청에 추가합니다.

기여

기여를 환영합니다! AI 코드 검토자 GitHub 작업을 개선하려면 언제든지 문제를 제출하거나 요청을 가져오시기 바랍니다.

관리자가 최종 패키지( yarn build 및 yarn package )를 생성하도록 합니다.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 LICENSE 파일을 참조하세요.