code sniff ai
1.0.0
Code-Sniff-AI est un script shell qui examine automatiquement les modifications de code. Git Diff est utilisé pour extraire le contenu modifié pour certains formats de fichiers et une revue du code modifié via l'API.
code-sniff-ai
├── .env
├── .env.sample
├── .gitignore
├── README.md
├── example
│ ├── javascript
│ │ └── HelloWorld.js
│ └── python
│ └── hello_world.py
└── run-review.sh
Créez .env en faisant référence au fichier .env.sample et définissez les variables d'environnement nécessaires.
Ce script nécessite jq . Si jq n'est pas installé, vous pouvez l'installer en utilisant la commande suivante.
Ubuntu / Linux :
sudo apt-get install jqMacOS :
brew install jq Windows : vous pouvez télécharger et utiliser jq.exe à partir de la page de version officielle de JQ. Enregistrez les fichiers téléchargés sur le chemin d'accès approprié et ajoutez le chemin du chemin au chemin du système.
git add .run-review.sh pour effectuer des avis de code pour les fichiers tachés. ./run-review.shCe script doit être exécuté sur le répertoire racine du référentiel GIT et passe en revue les modifications mise en scène dans le GIT.
Fondamentalement, nous examinons le fichier de l'extension suivante. Vous pouvez le configurer en tant que variable d'environnement selon les besoins.
example/javascript/HelloWorld.js contient un exemple de classe JavaScript simple.
class HelloWorld {
constructor ( ) {
this . message = "Hello, World!" ;
}
sayHello ( ) {
console . log ( this . message ) ;
}
} Ce code est " sayHello , monde!" Il s'agit d'une classe simple qui diffuse un message à la console.
example/python/hello_world.py contient un exemple de classe Python simple.
class HelloWorld :
def __init__ ( self ):
self . message = 'Hello, World!'
def say_hello ( self ):
print ( self . message )
if __name__ == "__main__" :
hello = HelloWorld ()
hello . say_hello () Ce code est " say_hello , monde!" Il s'agit d'une classe simple qui diffuse un message à la console.
Le modèle que vous souhaitez utiliser à Ollama doit être téléchargé à l'aide de la commande d' ollama pull à l'avance. Par exemple, pour utiliser le modèle gemma2 , exécutez la commande ci-dessous pour télécharger le modèle:
ollama pull gemma2 Nous étudions comment intégrer code-sniff-ai dans le flux de travail GIT pour rendre l'automatisation de la revue de code plus efficace. Par exemple, nous recherchons des moyens de déclencher automatiquement des avis de code lors de la poussée vers une branche spécifique ou d'exécuter des avis automatiques lors de la création de PR. Une telle intégration peut améliorer le processus de développement en l'incluant dans le pipeline CI / CD.
Nous étudions la possibilité d'appliquer une ingénierie rapide pour améliorer la précision et la qualité des revues de code. Nous expérimentons diverses mesures de configuration rapide afin que le modèle d'IA puisse fournir une rétroaction plus sophistiquée, ce qui maximisera l'efficacité du processus d'examen du code.
Si vous souhaitez contribuer, débarquez le projet, créez une nouvelle branche, reflétez les modifications et soumettez une demande complète.
Ce projet a reçu une licence avec licence MIT.
