ai codereviewer

Рецензент кода ИИ

AI Code Reviewer — это действие GitHub, которое использует API OpenAI GPT-4 для предоставления интеллектуальных отзывов и предложений по вашим запросам на включение. Этот мощный инструмент помогает улучшить качество кода и экономит время разработчиков за счет автоматизации процесса проверки кода.

Функции

• Проверяет запросы на включение с использованием API GPT-4 OpenAI.
• Предоставляет интеллектуальные комментарии и предложения по улучшению вашего кода.
• Отфильтровывает файлы, соответствующие указанным шаблонам исключения.
• Легко настроить и интегрировать в рабочий процесс GitHub.

Настраивать

1. Чтобы использовать это действие GitHub, вам понадобится ключ API OpenAI. Если у вас его нет, зарегистрируйтесь для получения ключа API на OpenAI.

2. Добавьте ключ API OpenAI в качестве секрета GitHub в свой репозиторий с именем OPENAI_API_KEY . Более подробную информацию о секретах GitHub можно найти здесь.

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 получает разницу в запросе на включение, отфильтровывает исключенные файлы и отправляет фрагменты кода в API OpenAI. Затем он генерирует комментарии обзора на основе ответа ИИ и добавляет их в запрос на включение.

Содействие

Вклады приветствуются! Пожалуйста, не стесняйтесь сообщать о проблемах или отправлять запросы на включение, чтобы улучшить действие AI Code Reviewer GitHub.

Позвольте сопровождающему сгенерировать окончательный пакет ( yarn build и yarn package ).

Лицензия

Этот проект лицензируется по лицензии MIT. Дополнительную информацию смотрите в файле LICENSE.