CONTRIBUTING.md

Guide de Contribution

Merci de votre intérêt à contribuer au Neural Chat Engine ! Ce document fournit les lignes directrices pour contribuer au projet.

Comment Contribuer

1. Fork & Clone

   • Forkez le dépôt
   • Clonez votre fork localement

2. Configuration de l'Environnement

   • Assurez-vous d'avoir Docker installé
   • Suivez les instructions d'installation dans le README.md

3. Branches

   • Créez une branche pour chaque fonctionnalité/correction
   • Utilisez des noms descriptifs (ex: feature/nouvelle-fonctionnalite ou fix/correction-bug)

4. Développement

   • Suivez les standards de code du projet
   • Ajoutez des tests pour les nouvelles fonctionnalités
   • Documentez votre code

5. Tests

   • Exécutez la suite de tests complète
   • Assurez-vous que tous les tests passent
   • Ajoutez de nouveaux tests si nécessaire

6. Soumission

   • Committez vos changements avec des messages clairs
   • Poussez vers votre fork
   • Créez une Pull Request

Standards de Code

• Suivez PEP 8 pour Python
• Utilisez des noms descriptifs pour les variables et fonctions
• Commentez le code complexe
• Documentez les fonctions et classes avec docstrings

Tests

• Écrivez des tests unitaires avec pytest
• Incluez des tests d'intégration si nécessaire
• Maintenez une couverture de code > 80%

Documentation

• Mettez à jour la documentation pour les nouvelles fonctionnalités
• Incluez des exemples d'utilisation
• Documentez les changements d'API

Pull Requests

1. Mettez à jour la branche avec main
2. Résolvez les conflits si nécessaire
3. Assurez-vous que tous les tests passent
4. Attendez la revue de code
5. Effectuez les modifications demandées

Questions

Pour toute question, ouvrez une issue sur GitHub.