CR-Mentor: база знаний + LLM-ориентированный интеллектуальный ментор по проверке кода для GitHub

Последние ресурсы по искусственному интеллектуОбновлено 10 месяцев назад Круг обмена ИИ

8.6K 00

Общее введение

CR-Mentor - это интеллектуальный инструмент для рецензирования кода, сочетающий профессиональную базу знаний с возможностями моделирования большого языка (LLM). Он не только поддерживает рецензирование кода на всех языках программирования, но и настраивает критерии рецензирования и области фокусировки для команд на основе лучших практик, накопленных в базе знаний. Благодаря постоянному накоплению базы знаний и глубокому обучению CR-Mentor может эффективно повысить качество кода команды и значительно сократить время рецензирования и количество ошибок.

Список функций

Полноязычный обзор кода: Поддержка рецензирования кода для всех основных языков программирования.
Индивидуальные критерии проверки: Настройте эксклюзивные критерии оценки для команд на основе лучших практик из базы знаний.
Интеллектуальная проверка одного документа: Сочетание опыта работы с базой знаний с анализом LLM для предоставления профессиональных оценок и рекомендаций по улучшению изменений кода в одном файле.
Глобальный анализ кода: На основе всех задокументированных изменений в коде предоставить полный отчет об обзоре с помощью LLM, включая прохождение кода, описание изменений и временные диаграммы.
Глубокая интеграция с GitHub: Бесшовное взаимодействие с рабочими процессами GitHub для автоматизации обзоров кода.
Многоязычный ответ: Язык для поддержки пользовательской обратной связи при обзоре кода.

Использование помощи

Процесс установки

Регистрация и вход: Создайте учетную запись CR-Mentor и войдите в систему.
Установка CR-Mentor: Добавьте CR-Mentor в свой репозиторий GitHub.
Создание Pull Request: Отправьте PR в ваш публичный репозиторий для проверки кода.

Процесс использования

Отправить код: Зафиксируйте свой код в репозитории GitHub.
Автоматический обзорCR-Mentor автоматически анализирует код и генерирует подробный отчет об обзоре кода.
Посмотреть отчет: Отчет включает в себя описание кода, описание изменений и временные диаграммы, чтобы помочь разработчикам понять влияние изменений кода.
Рекомендации по оптимизации: Оптимизация кода для улучшения его качества и производительности на основе рекомендаций, содержащихся в отчете.

Подробные шаги

Регистрация и входЧтобы зарегистрироваться: зайдите на сайт CR-Mentor, нажмите на кнопку "Регистрация" и заполните необходимую информацию для завершения регистрации. После регистрации используйте зарегистрированную учетную запись и пароль для входа в систему.
Установка CR-Mentor: После входа в систему перейдите на страницу "Руководство по установке" и выполните шаги по добавлению CR-Mentor в ваш репозиторий GitHub. Шаги следующие:
- Создайте новый репозиторий или выберите существующий на GitHub.
- В настройках репозитория добавьте GitHub App для CR-Mentor.
- Настройте URL Webhook и другую необходимую информацию.
Создание Pull Request: В своем репозитории GitHub создайте новую ветку и внесите изменения в код. После фиксации изменений создайте Pull Request, и CR-Mentor автоматически начнет проверку кода.
Просмотреть отчет об обзореCR-Mentor генерирует подробный отчет об обзоре кода, который включает в себя описание кода, примечания к изменениям и временные диаграммы. Разработчики могут просмотреть отчет на странице Pull Request на GitHub.
Оптимизированный кодРекомендации CR-Mentor основаны на лучших практиках из базы знаний и анализе LLM и помогают разработчикам улучшить качество и производительность кода.

предостережение

Индивидуальные критерии проверки: На странице настроек CR-Mentor вы можете настроить критерии проверки кода в соответствии с потребностями вашего проекта. Настройка критериев гарантирует, что код соответствует лучшим практикам команды.
Поддержка нескольких языковCR-Mentor поддерживает рецензирование кода на нескольких языках программирования. Разработчики могут выбрать язык для рецензирования на странице настроек.
Экспорт отчетовОтчеты об обзорах можно экспортировать в форматы PDF, HTML и Markdown для удобства обмена и архивирования.

стек технологий

🔥 Использование Next.js App Router Создание современных веб-приложений
🎨 Используйте Tailwind CSS Достижение элегантного отзывчивого дизайна
🔐 Используйте Клерк Обеспечьте безопасную и надежную аутентификацию пользователей
📦 Используйте Supabase Обеспечение высокопроизводительного хранения данных
🔗 Используйте Приложение Github Реализация глубокой интеграции с GitHub
🧠 Используйте Dify Построение интеллектуального LLM рабочий процесс

Руководство по развертыванию

Вы можете развернуть этот шаблон, настроив следующие службы и добавив соответствующие переменные окружения:

быть в движении npm install Установите зависимости и запустите npm run dev Запустите сервер разработки.
Система попросит вас предоставить CLERK_SECRET_KEY. Конкретные шаги следующие:
- Зарегистрироваться Клерк Счет.
- через (щель) Ключи API сделать копию CLERK_SECRET_KEY ответить пением NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY до (времени) .env.local Документация.
Теперь ваши front-end и back-end должны быть запущены, и вы можете войти в систему, но еще не делать обзор кода.
Создайте Supabase Счет для получения Ключ API.
1. Создайте проект Supabase в Project Settings Воспроизведено в.
  - SUPABASE_URL
  - SUPABASE_KEY
  Выполните следующий оператор SQL, чтобы создать githubId_clerkId Таблица.
```
CREATE TABLE "public"."githubId_clerkId" (
"github_id" text NOT NULL,
"clerk_id" text NOT NULL,
PRIMARY KEY ("github_id")
);
```
  Выполните следующий оператор SQL, чтобы создать repoName_file Таблица.
```
CREATE TABLE "public"."repoName_file" (
"repo_fullName" text NOT NULL,
"file_name" text NOT NULL,
"folder_name" text NOT NULL,
PRIMARY KEY ("repo_fullName", "file_name", "folder_name")
);
```
2. существовать Storage (используется в форме номинального выражения) S3 Connection Воспроизведено в.
  - SUPABASE_S3_ENDPOINT
  - SUPABASE_S3_REGION
3. существовать Storage (используется в форме номинального выражения) S3 Access Keys Новое в.
  - SUPABASE_STORE_ID
  - SUPABASE_STORE_SECRET_KEY
4. существовать Storage попал в точку New bucket Новое ведро.
  - Заполните имя ведра в поле SUPABASE_BUCKET_NAME
```
SUPABASE_URL=
SUPABASE_KEY=
SUPABASE_S3_ENDPOINT=
SUPABASE_S3_REGION=
SUPABASE_STORE_ID=
SUPABASE_STORE_SECRET_KEY=
SUPABASE_BUCKET_NAME=
```
Создайте Github учетную запись, а затем создайте Приложение Github.
- существовать Settings -> Developer settings -> GitHub Apps щелчок New GitHub App.
- записывать данные в поле (в анкете или веб-форме) GitHub App name, иHomepage URL, иWebhook URL и другую информацию.
- создание Private key и скачать, скопировать App ID, иClient ID, иClient secret до (времени) .env.local Документация.
```
GITHUB_APP_ID=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

# 只填写 -----BEGIN RSA PRIVATE KEY----- 和 -----END RSA PRIVATE KEY----- 之间的内容
GITHUB_PRIVATE_KEY=
```
Создайте учетную запись Dify и настройте рабочий процесс LLM.
1. Зарегистрируйтесь в учетной записи Dify и настройте модель LLM с помощью поставщика модели
2. существовать Студия Dify Рабочий процесс импорта.
  - Нажмите "Создать приложение" и выберите "Импорт DSL".
  - Переключитесь в режим URL и введите URL файла рабочего процесса. https://ovlxxbdwimhigoejxkqn.supabase.co/storage/v1/object/public/test-bucket-api/Dify_DSL/CR-Mentor.yml
  - Нажмите кнопку Создать, чтобы завершить импорт.
3. Опубликуйте рабочий процесс.
  - Нажмите кнопку Опубликовать на странице Аранжировка.
4. Получить ключ API.
  - Нажмите на "Доступ к API" в левой навигационной панели.
  - Перейдите на страницу "Workflow App API".
  - Нажмите "API Key" в правом верхнем углу, чтобы создать новый секретный ключ.
  - Скопируйте секретный ключ в .env.local Документация.
```
DIFY_APIKEY=
DIFY_BASE_URL=https://api.dify.ai/v1  # 固定值
```