CR-Mentor: Base de conocimientos + LLM Mentor inteligente de revisión de código para GitHub

Introducción general

CR-Mentor es una herramienta inteligente de revisión de código que combina una base de conocimientos profesionales con la potencia de Large Language Modelling (LLM). No solo admite la revisión de código en todos los lenguajes de programación, sino que también personaliza los criterios de revisión y las áreas de enfoque para los equipos en función de las mejores prácticas acumuladas en la base de conocimientos. Mediante la acumulación continua de la base de conocimientos y el aprendizaje profundo, CR-Mentor puede mejorar eficazmente la calidad del código del equipo y reducir significativamente el tiempo de revisión y la tasa de errores.

Lista de funciones

• Revisión completa del código: Soporte de revisión de código para los principales lenguajes de programación.
• Criterios de revisión personalizados: Personalice criterios de revisión exclusivos para equipos basados en las mejores prácticas de la base de conocimientos.
• Revisión inteligente de documentos individuales: Combina la experiencia de la base de conocimientos con el análisis LLM para proporcionar una puntuación profesional y recomendaciones de mejora para los cambios de código de un solo archivo.
• Análisis global del códigoRevisión: Basándose en todos los cambios de código documentados, proporcione un informe de revisión exhaustivo a través de LLM, que incluya recorridos por el código, descripciones de los cambios y gráficos de sincronización.
• Integración profunda en GitHubInterfaz perfecta con los flujos de trabajo de GitHub para automatizar las revisiones de código.
• Respuesta multilingüeLenguaje de revisión de código personalizado

Utilizar la ayuda

Proceso de instalación

1. Registrarse e iniciar sesiónCrear una cuenta CR-Mentor e iniciar sesión.
2. Instalación de CR-MentorAñade CR-Mentor a tu repositorio de GitHub.
3. Creación de una Pull Request: Envíe un PR en su repositorio público para la revisión del código.

Proceso de utilización

1. Enviar códigoCompila tu código en un repositorio de GitHub.
2. Revisión automáticaCR-Mentor analiza automáticamente el código y genera un informe detallado de revisión del código.
3. Ver informeEl informe incluye recorridos por el código, descripciones de los cambios y diagramas de sincronización para ayudar a los desarrolladores a comprender el impacto de los cambios en el código.
4. Recomendaciones de optimizaciónOptimizar el código para mejorar la calidad y el rendimiento en función de las recomendaciones del informe.

Pasos detallados

1. Registrarse e iniciar sesiónPara registrarse: visite el sitio web de CR-Mentor, haga clic en el botón "Registrarse" y rellene la información necesaria para completar su registro. Una vez registrado, utilice la cuenta y la contraseña registradas para iniciar sesión.
2. Instalación de CR-MentorDespués de iniciar sesión, ve a la página Guía de instalación y sigue los pasos para añadir CR-Mentor a tu repositorio de GitHub. Los pasos son los siguientes:
   • Crea un nuevo repositorio o selecciona uno existente en GitHub.
   • En la configuración del repositorio, añada la aplicación GitHub para CR-Mentor.
   • Configure la URL del Webhook y otra información necesaria.
3. Creación de una Pull RequestEn su repositorio de GitHub, cree una nueva rama y realice cambios en el código. Después de confirmar los cambios, crea una Pull Request y CR-Mentor iniciará automáticamente una revisión del código.
4. Ver el informe de revisiónCR-Mentor genera un informe detallado de revisión del código que incluye recorridos por el código, notas de cambio y diagramas de sincronización. Los desarrolladores pueden ver el informe en la página Pull Request de GitHub.
5. Código optimizadoLas recomendaciones de CR-Mentor se basan en las mejores prácticas de la base de conocimientos y en el análisis de LLM para ayudar a los desarrolladores a mejorar la calidad y el rendimiento del código.

advertencia

• Criterios de revisión personalizadosEn la página de configuración de CR-Mentor, puede personalizar los criterios de revisión del código según las necesidades de su proyecto. La personalización de los criterios garantiza que el código cumpla con las mejores prácticas del equipo.
• Soporte multilingüeCR-Mentor admite la revisión de código en varios lenguajes de programación. Los desarrolladores pueden seleccionar el lenguaje a revisar en la página de configuración.
• Exportación de informes: Los informes de revisión pueden exportarse a formatos PDF, HTML y Markdown para compartirlos y archivarlos fácilmente.

pila tecnológica

• 🔥 Uso de Next.js App Router Creación de aplicaciones web modernas
• 🎨 Uso Tailwind CSS Lograr un diseño adaptable elegante
• 🔐 Uso Secretaria Autenticación de usuarios segura y fiable
• 📦 Uso Supabase Almacenamiento de datos de alto rendimiento
• 🔗 Uso Aplicación Github Implementación de una integración profunda con GitHub
• 🧠 Uso Dify Construir un LLM inteligente flujo de trabajo

Guía de implantación

Puede desplegar esta plantilla configurando los siguientes servicios y añadiendo las variables de entorno apropiadas:

1. estar en movimiento npm install Instale las dependencias y ejecute npm run dev Inicie el servidor de desarrollo.
2. El sistema le pedirá que indique CLERK_SECRET_KEY. Los pasos concretos son los siguientes:
   • Inscríbete en Secretaria Cuenta.
   • a través de (un hueco) Claves API haga una copia de CLERK_SECRET_KEY responder cantando NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY hasta .env.local Documentación.
3. Ahora su front-end y back-end deberían estar funcionando y puede iniciar sesión, pero aún no hacer una revisión de código.
4. Crear un Supabase Cuenta para obtener Clave API.
   1. Crear un proyecto Supabase en Project Settings Reproducido en.
      • SUPABASE_URL
      • SUPABASE_KEY

      Ejecute la siguiente sentencia SQL para crear githubId_clerkId Mesa.

      CREATE TABLE "public"."githubId_clerkId" (
      "github_id" text NOT NULL,
      "clerk_id" text NOT NULL,
      PRIMARY KEY ("github_id")
      );
      

      Ejecute la siguiente sentencia SQL para crear repoName_file Mesa.

      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. existe Storage (utilizado como expresión nominal) S3 Connection Reproducido en.
      • SUPABASE_S3_ENDPOINT
      • SUPABASE_S3_REGION
   3. existe Storage (utilizado como expresión nominal) S3 Access Keys Nuevo en.
      • SUPABASE_STORE_ID
      • SUPABASE_STORE_SECRET_KEY
   4. existe Storage ha dado en el clavo New bucket Nuevo cubo.
      • Introduzca el nombre del cubo en el campo SUPABASE_BUCKET_NAME

   SUPABASE_URL=
   SUPABASE_KEY=
   SUPABASE_S3_ENDPOINT=
   SUPABASE_S3_REGION=
   SUPABASE_STORE_ID=
   SUPABASE_STORE_SECRET_KEY=
   SUPABASE_BUCKET_NAME=
   

5. Crear un Github y, a continuación, cree una cuenta Aplicación Github.
   • existe Settings -> Developer settings -> GitHub Apps haciendo clic en New GitHub App.
   • escribir datos en una casilla (en un cuestionario o formulario web) GitHub App nameyHomepage URLyWebhook URL y otra información.
   • generando Private key y descargar, copiar App IDyClient IDyClient secret hasta .env.local Documentación.

   GITHUB_APP_ID=
   GITHUB_CLIENT_ID=
   GITHUB_CLIENT_SECRET=
   
   # 只填写 -----BEGIN RSA PRIVATE KEY----- 和 -----END RSA PRIVATE KEY----- 之间的内容
   GITHUB_PRIVATE_KEY=
   

6. Cree una cuenta en Dify y configure un flujo de trabajo LLM.
   1. Regístrese en una cuenta de Dify y configure el modelo LLM con el proveedor del modelo
   2. existe Estudio Dify Flujo de trabajo de importación.
      • Haga clic en "Crear aplicación" y seleccione "Importar DSL".
      • Cambie al modo URL e introduzca la URL del archivo de flujo de trabajo. https://ovlxxbdwimhigoejxkqn.supabase.co/storage/v1/object/public/test-bucket-api/Dify_DSL/CR-Mentor.yml
      • Haga clic en Crear para completar la importación
   3. Publica un flujo de trabajo.
      • Haga clic en el botón Publicar de la página Arrangement.
   4. Obtener clave API.
      • Haga clic en "Acceso API" en la barra de navegación de la izquierda.
      • Cambie a la página "Workflow App API".
      • Haga clic en "Clave API" en la esquina superior derecha para crear una nueva clave secreta.
      • Copie la clave secreta en .env.local Documentación.

      DIFY_APIKEY=
      DIFY_BASE_URL=https://api.dify.ai/v1  # 固定值