CR-Mentor: Base de conhecimento + Mentor de revisão de código inteligente orientado por LLM para GitHub

Introdução geral

O CR-Mentor é uma ferramenta inteligente de revisão de código que combina uma base de conhecimento profissional com o poder da Modelagem de Linguagem Grande (LLM). Ele não apenas oferece suporte à revisão de código em todas as linguagens de programação, mas também personaliza os critérios de revisão e as áreas de foco para as equipes com base nas práticas recomendadas acumuladas na base de conhecimento. Por meio do acúmulo contínuo da base de conhecimento e da aprendizagem profunda, o CR-Mentor pode melhorar efetivamente a qualidade do código da equipe e reduzir significativamente o tempo de revisão e a taxa de erros.

Lista de funções

• Revisão completa do código do idiomaSuporte à revisão de código para todas as principais linguagens de programação.
• Critérios de revisão personalizadosPersonalize critérios de revisão exclusivos para equipes com base nas práticas recomendadas da base de conhecimento.
• Revisão inteligente de um único documentoCombine a experiência da base de conhecimento com a análise do LLM para fornecer pontuação profissional e recomendações de aprimoramento para alterações de código de arquivo único.
• Análise de código globalCom base em todas as alterações de código documentadas, forneça um relatório de revisão abrangente por meio do LLM, incluindo orientações de código, descrições de alterações e gráficos de tempo.
• Integração profunda do GitHubInterface perfeita com fluxos de trabalho do GitHub para automatizar revisões de código.
• Resposta em vários idiomasLinguagem para oferecer suporte a feedback personalizado de revisão de código.

Usando a Ajuda

Processo de instalação

1. Registro e loginCrie uma conta no CR-Mentor e faça login.
2. Instalação do CR-MentorAdicione o CR-Mentor ao seu repositório do GitHub.
3. Criação de uma solicitação pullEnvie um PR em seu repositório público para revisão de código.

Processo de uso

1. Enviar códigoComprometa seu código em um repositório do GitHub.
2. Revisão automáticaCR-Mentor analisa automaticamente o código e gera um relatório detalhado de revisão de código.
3. Exibir relatórioO relatório inclui orientações de código, descrições de alterações e diagramas de tempo para ajudar os desenvolvedores a entender o impacto das alterações de código.
4. Recomendações de otimizaçãoOtimização do código para melhorar a qualidade e o desempenho do código com base nas recomendações do relatório.

Etapas detalhadas

1. Registro e loginPara se registrar: Visite o site do CR-Mentor, clique no botão "Register" (Registrar) e preencha as informações necessárias para concluir seu registro. Após o registro, use a conta e a senha registradas para fazer login.
2. Instalação do CR-MentorApós fazer login, acesse a página Guia de instalação e siga as etapas para adicionar o CR-Mentor ao seu repositório do GitHub. As etapas são as seguintes:
   • Crie um novo repositório ou selecione um já existente no GitHub.
   • Nas configurações do repositório, adicione o aplicativo GitHub para o CR-Mentor.
   • Configure o URL do webhook e outras informações necessárias.
3. Criação de uma solicitação pullEm seu repositório do GitHub, crie uma nova ramificação e faça alterações no código. Depois de confirmar as alterações, crie um Pull Request e o CR-Mentor iniciará automaticamente uma revisão de código.
4. Veja o relatório de revisãoO CR-Mentor gera um relatório detalhado de revisão de código que inclui orientações de código, notas de alteração e diagramas de tempo. Os desenvolvedores podem visualizar o relatório na página Pull Request no GitHub.
5. Código otimizadoAs recomendações do CR-Mentor são baseadas nas práticas recomendadas da base de conhecimento e na análise do LLM para ajudar os desenvolvedores a melhorar a qualidade e o desempenho do código.

advertência

• Critérios de revisão personalizadosNa página de configurações do CR-Mentor, você pode personalizar os critérios de revisão de código de acordo com as necessidades do seu projeto. A personalização dos critérios garante que o código esteja em conformidade com as práticas recomendadas da equipe.
• Suporte a vários idiomasO CR-Mentor oferece suporte à revisão de código em várias linguagens de programação. Os desenvolvedores podem selecionar o idioma a ser revisado na página de configurações.
• Exportação de relatóriosRelatórios de revisão: os relatórios de revisão podem ser exportados para os formatos PDF, HTML e Markdown para facilitar o compartilhamento e o arquivamento.

pilha de tecnologia

• Usando o Next.js Roteador de aplicativos Criação de aplicativos da Web modernos
• 🎨 Uso Tailwind CSS Obtendo um design responsivo elegante
• 🔐 Uso Escriturário Fornecer autenticação de usuário segura e confiável
• 📦 Uso Supabase Possibilitando o armazenamento de dados de alto desempenho
• 🔗 Uso Aplicativo do Github Implementação da integração profunda com o GitHub
• 🧠 Uso Dify Criando um LLM inteligente fluxo de trabalho

Guia de implantação

Você pode implementar esse modelo configurando os seguintes serviços e adicionando as variáveis de ambiente apropriadas:

1. estar em movimento npm install Instale as dependências e execute npm run dev Inicie o servidor de desenvolvimento.
2. O sistema solicitará que você forneça CLERK_SECRET_KEY. As etapas específicas são as seguintes:
   • Registre-se para um Escriturário Conta.
   • através de (uma lacuna) Chaves de API fazer uma cópia de CLERK_SECRET_KEY responder cantando NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY até .env.local Documentação.
3. Agora o front-end e o back-end devem estar em execução e você pode fazer login, mas ainda não pode fazer uma revisão de código.
4. Criar um Supabase Conta para obter Chave da API.
   1. Crie um projeto Supabase em Project Settings Reproduzido em.
      • SUPABASE_URL
      • SUPABASE_KEY

      Execute a seguinte instrução SQL para criar githubId_clerkId Tabela.

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

      Execute a seguinte instrução SQL para criar repoName_file Tabela.

      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. existir Storage (usado em uma expressão nominal) S3 Connection Reproduzido em.
      • SUPABASE_S3_ENDPOINT
      • SUPABASE_S3_REGION
   3. existir Storage (usado em uma expressão nominal) S3 Access Keys Novo em.
      • SUPABASE_STORE_ID
      • SUPABASE_STORE_SECRET_KEY
   4. existir Storage acertou em cheio New bucket Nova caçamba.
      • Digite o nome do Bucket no 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. Criar um Github e, em seguida, crie uma conta Aplicativo do Github.
   • existir Settings -> Developer settings -> GitHub Apps clicando em New GitHub App.
   • escrever dados em uma caixa (em um questionário ou formulário da Web) GitHub App nameeHomepage URLeWebhook URL e outras informações.
   • gerando Private key e fazer download, copiar App IDeClient IDeClient secret até .env.local Documentação.

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

6. Crie uma conta Dify e configure um fluxo de trabalho LLM.
   1. Registre-se em uma conta Dify e configure o modelo LLM com o provedor de modelos
   2. existir Dify Studios Fluxo de trabalho de importação.
      • Clique em "Create Application" (Criar aplicativo) e selecione "Import DSL" (Importar DSL).
      • Alterne para o modo URL e preencha o URL do arquivo de fluxo de trabalho. https://ovlxxbdwimhigoejxkqn.supabase.co/storage/v1/object/public/test-bucket-api/Dify_DSL/CR-Mentor.yml
      • Clique em Criar para concluir a importação
   3. Publique um fluxo de trabalho.
      • Clique no botão Publicar na página Arranjo.
   4. Obter chave de API.
      • Clique em "API Access" (Acesso à API) na barra de navegação à esquerda.
      • Vá para a página "API do aplicativo de fluxo de trabalho".
      • Clique em "API Key" (Chave de API) no canto superior direito para criar uma nova chave secreta.
      • Copie a chave secreta para .env.local Documentação.

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