co op gitlab

Réviseur de code

Automatiser les avis et les commentaires du code pour les demandes de fusion de GitLab à l'aide d'Openai GPT-3/4

Commencez avec Code Reviewer en suivant les instructions dans la section de démarrage

Introduction · Fonctionnalités · Début · Utilisation · Auteur

Introduction

Le réviseur de code est un outil qui s'intègre à GitLab et Openai GPT-3/4 pour examiner et fournir automatiquement des commentaires sur les demandes de fusion. Il valide les extraits de code, suggère des améliorations et garantit que les meilleures pratiques sont suivies.

Exigences

• Node.js 18+ et npm
• Compte gitlab
• Clé API Openai

? Caractéristiques

• S'intègre aux demandes de fusion Gitlab
• Fournit une revue de code automatisée et des commentaires à l'aide d'Openai GPT-3/4
• Prend en charge plusieurs langages de programmation
• Assure le respect des meilleures pratiques et des normes de codage
• Simplifie le processus d'examen du code

??commencer

Pour commencer avec le réviseur de code, suivez les étapes ci-dessous:

1. Clone le référentiel:

git clone https://github.com/yourusername/code-reviewer.git
cd code-reviewer

2. Installez les dépendances:

npm install

3. Créez un fichier .env dans le dossier racine et ajoutez les variables suivantes:

GITLAB_TOKEN=your_gitlab_token
OPENAI_API_KEY=your_openai_api_key

Remplacez votre_gitlab_token par votre jeton d'accès personnel GitLab et votre_Openai_API_KEY par votre clé API OpenAI.

4. Construisez le projet:

npm run build

5. Démarrez le serveur:

npm run start

Usage

1. Dans votre projet GitLab, créez un webhook qui déclenche sur les événements de demande de fusion.

2. Définissez l'URL WebHook sur le point de terminaison de votre serveur de réviseur de code (par exemple, https://your-code-reviewer-server.com/webhook).

3. Lorsqu'une demande de fusion est créée ou mise à jour dans votre projet GitLab, le réviseur de code examinera automatiquement le code et fournira des commentaires en tant que commentaires sur la demande de fusion.

? Contributif

1. Fourk ce référentiel;
2. Créez votre branche: git checkout -b my-awesome-contribution ;
3. Commissez vos modifications: git commit -m 'feat: Add some awesome contribution' ;
4. Poussez à la branche: git push origin my-awesome-contribution .

? Licence

Licencié sous la licence MIT, Copyright © 2023

Voir la licence pour plus d'informations.

? Auteur

• Rik Vermeulen (@rikvermeulen_)