Nous sommes ravis que vous souhaitiez contribuer au projet SafeZone AI ! Vos contributions sont précieuses pour améliorer ce système de sécurité en temps réel.
Ce document décrit les lignes directrices pour contribuer au projet. En contribuant, vous acceptez de respecter ce guide.
Si vous trouvez un bug, veuillez ouvrir une nouvelle issue sur GitHub. Avant de soumettre une nouvelle issue, veuillez vérifier si une issue similaire n'existe pas déjà.
Lorsque vous signalez un bug, veuillez inclure :
- Une description claire et concise du bug.
- Les étapes pour reproduire le bug.
- Le comportement attendu et le comportement actuel.
- Des captures d'écran ou des logs si possible.
- Votre environnement (système d'exploitation, version de Python, dépendances).
Nous sommes ouverts aux nouvelles idées et améliorations. Si vous avez une suggestion de fonctionnalité, veuillez ouvrir une nouvelle issue sur GitHub.
Lorsque vous suggérez une fonctionnalité, veuillez inclure :
- Une description claire et concise de la fonctionnalité proposée.
- Pourquoi cette fonctionnalité serait utile pour le projet.
- Des exemples d'utilisation si possible.
Pour les contributions de code, veuillez suivre les étapes suivantes :
-
Fork le dépôt sur GitHub.
-
Clonez votre fork localement :
git clone https://github.com/votre_utilisateur/SafeZone-AI.git cd SafeZone-AI -
Créez une nouvelle branche pour vos modifications. Utilisez un nom descriptif (par exemple,
feature/nouvelle-fonctionnaliteoubugfix/corriger-erreur-x) :git checkout -b feature/ma-nouvelle-fonctionnalite
-
Effectuez vos modifications. Assurez-vous que votre code respecte les conventions de style existantes et qu'il est bien commenté.
-
Testez vos modifications. Si vous ajoutez de nouvelles fonctionnalités, veuillez inclure des tests unitaires ou d'intégration si possible.
-
Commitez vos modifications avec un message de commit clair et concis. Le message de commit doit décrire ce que la modification fait et pourquoi elle a été faite.
git commit -m "feat: Ajouter une nouvelle fonctionnalité X"Types de commits recommandés (inspirés de Conventional Commits) :
feat: Nouvelle fonctionnalitéfix: Correction de bugdocs: Changements de documentationstyle: Formatage, points-virgules manquants, etc. (pas de changement de code)refactor: Refactoring du code (pas de changement de fonctionnalité ni de bug)test: Ajout de tests manquants ou correction de tests existantschore: Mises à jour de la construction, des dépendances, etc.
-
Poussez vos modifications vers votre fork sur GitHub :
git push origin feature/ma-nouvelle-fonctionnalite
-
Ouvrez une Pull Request depuis votre fork vers la branche
maindu dépôt original. Veuillez inclure :- Une description détaillée de vos modifications.
- Les problèmes que votre PR résout (référencez les issues si applicable, par exemple
Closes #123). - Toute information supplémentaire pertinente (captures d'écran, résultats de tests).
- Python : Suivez les conventions de style PEP 8.
- JavaScript/CSS/HTML : Suivez les bonnes pratiques pour le développement web.
- Commentaires : Commentez votre code de manière claire et concise, en expliquant les parties complexes ou non évidentes.
Si vous avez des questions sur le processus de contribution, n'hésitez pas à ouvrir une issue ou à nous contacter.
Merci de votre intérêt et de votre contribution à SafeZone AI !