Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (39 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

64 lines (39 loc) · 2.93 KB

Contribuer au projet

Nous sommes ravis que vous envisagiez de contribuer à notre projet ! Chaque contribution est importante et très appréciée.

Comment contribuer ?

Vous pouvez contribuer de plusieurs manières :

Rapporter des bugs

Si vous trouvez un bug, merci de le signaler en créant une "issue". Veuillez fournir autant de détails que possible pour que nous puissions comprendre et reproduire le problème. Ceci inclut :

  • Une description claire et concise du bug.
  • Des étapes pour reproduire le bug.
  • La version du logiciel utilisée.
  • Des captures d'écran ou des logs, si applicable.

Propositions d'améliorations

Si vous avez des suggestions pour améliorer le logiciel, n'hésitez pas à ouvrir une "issue" pour en discuter. Cela pourrait inclure de nouvelles fonctionnalités, des modifications des fonctionnalités existantes ou des améliorations de la documentation.

Soumission de modifications

Vous pouvez aussi soumettre directement vos modifications par une "pull request" (PR). Voici comment procéder :

  1. Fork le projet sur GitHub.
  2. Clonez votre fork sur votre machine locale.
  3. Créez une nouvelle branche pour vos modifications.
  4. Effectuez vos modifications.
  5. Committez vos changements avec des messages de commit explicatifs.
  6. Poussez votre branche sur votre fork.
  7. Ouvrez une pull request de votre branche vers la branche principale du projet original.
  8. Décrivez en détail les modifications proposées et toute autre information pertinente.

Code de Conduite

Nous attendons de tous les contributeurs qu'ils adhèrent à notre Code de Conduite. En participant à ce projet, vous acceptez de respecter ses termes.

Configuration de l'environnement de développement

Pour configurer l'environnement de développement sur votre machine locale, suivez les étapes suivantes :

  1. Installez toutes les dépendances nécessaires :

    pip install -r requirements.txt

  2. Configurez les variables d'environnement nécessaires.

  3. Lancez l'application en mode développement pour vérifier que tout fonctionne correctement.

Tests

Avant de soumettre une pull request, assurez-vous que votre code passe tous les tests existants et, si vous ajoutez de nouvelles fonctionnalités, ajoutez également des tests appropriés. Cela garantit que le code introduit ne casse pas les fonctionnalités existantes et répond aux critères de qualité du projet.

Besoin d'aide ?

Si vous avez des questions ou avez besoin d'aide pour configurer votre environnement de développement, n'hésitez pas à demander de l'aide via les "issues".

Remerciements

Nous tenons à remercier tous ceux qui contribuent à ce projet, que ce soit par des suggestions, des contributions directes au code ou par des discussions utiles.

Merci d'avoir choisi de contribuer à notre projet. Votre aide est essentielle pour le faire grandir et s'améliorer.