ai codereviewer

Réviseur de code IA

AI Code Reviewer est une action GitHub qui exploite l'API GPT-4 d'OpenAI pour fournir des commentaires et des suggestions intelligents sur vos demandes d'extraction. Cet outil puissant contribue à améliorer la qualité du code et fait gagner du temps aux développeurs en automatisant le processus de révision du code.

Caractéristiques

• Examine les demandes d'extraction à l'aide de l'API GPT-4 d'OpenAI.
• Fournit des commentaires et des suggestions intelligents pour améliorer votre code.
• Filtre les fichiers qui correspondent aux modèles d'exclusion spécifiés.
• Facile à configurer et à intégrer dans votre flux de travail GitHub.

Installation

1. Pour utiliser cette action GitHub, vous avez besoin d'une clé API OpenAI. Si vous n'en avez pas, inscrivez-vous pour obtenir une clé API sur OpenAI.

2. Ajoutez la clé API OpenAI en tant que secret GitHub dans votre référentiel avec le nom OPENAI_API_KEY . Vous pouvez trouver plus d’informations sur les secrets de GitHub ici.

3. Créez un fichier .github/workflows/main.yml dans votre référentiel et ajoutez le contenu suivant :

 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. Remplacez your-username par votre nom d'utilisateur GitHub ou le nom de votre organisation où se trouve le référentiel AI Code Reviewer.

5. Personnalisez l'entrée exclude si vous souhaitez ignorer certains modèles de fichiers lors de l'examen.

6. Validez les modifications dans votre référentiel et AI Code Reviewer commencera à travailler sur vos futures demandes d'extraction.

Comment ça marche

L'action GitHub d'AI Code Reviewer récupère le diff de la demande d'extraction, filtre les fichiers exclus et envoie des morceaux de code à l'API OpenAI. Il génère ensuite des commentaires de révision basés sur la réponse de l'IA et les ajoute à la demande d'extraction.

Contribuer

Les contributions sont les bienvenues ! N'hésitez pas à soumettre des problèmes ou des demandes de tirage pour améliorer l'action GitHub d'AI Code Reviewer.

Laissez le responsable générer le package final ( yarn build & yarn package ).

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus d'informations.