robin ai reviewer

Robin Ai

Nommé d'après l'assistant de Batman, Robin AI est un projet GitHub open source qui examine automatiquement les demandes GitHub Pull, fournissant un score (0-100), des améliorations suggérées et un exemple de code d'amélioration.

Installation

Pour utiliser Robin AI dans votre projet GitHub, vous devrez l'ajouter en tant qu'action GitHub. Voici comment:

1. Dans votre référentiel GitHub, accédez à l'onglet "Actions".
2. Cliquez sur le bouton "Nouveau workflow".
3. Sélectionnez l'option pour "configurer un workflow vous-même".
4. Copiez et collez le code suivant dans le nouveau fichier:

 name : Robin AI Reviewer

on :
  pull_request :
    branches : [main]
    types :
      - opened
      - reopened
      - ready_for_review

jobs :
  build :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v3
      - name : Robin AI Reviewer
        uses : Integral-Healthcare/robin-ai-reviewer@v[INSERT_LATEST_RELEASE]
        with :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
          OPEN_AI_API_KEY : ${{ secrets.OPEN_AI_API_KEY }}
          files_to_ignore : |
            "README.md"
            "assets/*"
            "package-lock.json"

5. Enregistrez le fichier avec un nom comme robin.yml .
6. Créez un secret dans votre référentiel GitHub appelé OPEN_AI_API_KEY et définissez-le sur la valeur de votre clé API AI ouverte.

Avec ces étapes terminées, Robin AI s'exécutera automatiquement chaque fois qu'une demande de traction est ouverte ou modifiée dans votre référentiel GitHub.

Arguments

Nom	Requis	Valeur par défaut	Description
GITHUB_TOKEN	Oui	Fourni automatiquement	Un jeton d'accès GitHub avec le repo et pull_request Scopes.
OPEN_AI_API_KEY	Oui	N / A	Une clé API du portail de développeur d'Open AI.
gpt_model_name	Non	gpt-3.5-turbo	Le nom du modèle GPT à utiliser pour la génération de texte.
github_api_url	Non	https://api.github.com	L'URL du point de terminaison de l'API GitHub. (Uniquement pertinent pour les clients d'entreprise.)
files_to_ignore	Non	(chaîne vide)	Une liste de fichiers délimitée dans l'espace à ignorer.

Open_AI_API_KEY

Vous devrez accéder au portail de développeur d'Openai pour générer une clé API. De plus, vous devrez mettre une carte dans le dossier avant que la clé API ne devienne active. Vous pouvez voir les détails des prix ici, mais pour le modèle gpt-3.5-turbo par défaut, le prix est $0.0015 / 1K tokens

Usage

Lorsque Robin AI s'exécute, il affichera un commentaire sur la demande de traction avec son score sur 100, des améliorations suggérées et un exemple de code d'amélioration. Vous pouvez utiliser ces informations pour améliorer la qualité de votre code et rendre vos demandes de traction plus susceptibles d'être acceptées.

Performance

Un grand accent a été mis sur la garantie d'un runtime performant.

Métrique	Valeur
Taille de l'image docker	15,6 Mo
Exécution de l'action moyenne	14s

L'image Docker pour Robin AI a une taille de 15,6 Mo, ce qui est relativement petit et devrait être rapide à télécharger et à utiliser. En moyenne, le runtime Robin AI GitHub Action est de 14 secondes, ce qui signifie qu'il devrait être en mesure de traiter les demandes de traction rapidement et efficacement. Ces mesures peuvent varier en fonction des facteurs tels que la taille et la complexité du code examiné, la vitesse de la connexion Internet et la disponibilité de l'API de l'IA ouverte.

Démo

Voici un lien vers la démo

Contributif

Si vous souhaitez contribuer à Robin AI, nous accueillons votre contribution! N'hésitez pas à soumettre des problèmes ou à extraire les demandes de notre référentiel GitHub. Vous pouvez également m'envoyer un message sur Twitter.

Licence

Robin AI est autorisé sous la licence du MIT. Voir LICENSE pour plus d'informations.