Skip to content

Contribution

Nous apprécions vos contributions à ce projet ! Suivez les étapes ci-dessous pour contribuer de manière efficace et structurée.

Étapes pour Contribuer

1. Fork le Dépôt

Cliquez sur le bouton "Fork" en haut de la page GitHub pour créer une copie de ce dépôt dans votre compte.

2. Cloner votre Fork Localement

Clonez votre dépôt forké sur votre machine locale.

git clone https://github.com/Artemis-IA/mlops_backend.git
cd mlops_backend

3. Créer une Branche pour votre Feature ou Correction

Créez une nouvelle branche pour travailler sur votre feature ou correction.

git checkout -b nom-de-votre-branche

4. Effectuer vos Changements et Commit

Effectuez les modifications nécessaires dans le code ou la documentation. Ajoutez et commitez vos changements.

git add .
git commit -m "Description de vos changements"

5. Pousser la Branche sur GitHub

Poussez votre branche locale vers votre fork sur GitHub.

git push origin nom-de-votre-branche

6. Créer une Pull Request

Allez sur votre dépôt forké sur GitHub et créez une Pull Request vers le dépôt original.

Checklist pour la Pull Request

  • [ ] Description Claire : Décrivez clairement les changements apportés.
  • [ ] Liens vers les Issues : Si votre PR résout une issue, mentionnez-la.
  • [ ] Tests : Ajoutez des tests si nécessaire pour vérifier vos changements.
  • [ ] Documentation : Mettez à jour la documentation si vos changements affectent celle-ci.

Bonnes Pratiques

  • Code Propre : Assurez-vous que votre code respecte les standards de codage du projet.
  • Commits Significatifs : Faites des commits atomiques avec des messages clairs.
  • Tester Localement : Testez vos changements localement avant de les pousser.
  • Revue de Code : Soyez prêt à recevoir des feedbacks et à apporter des modifications si nécessaire.

Documentation

Si vous souhaitez améliorer la documentation, suivez les mêmes étapes pour créer une Pull Request avec vos modifications.

Contact

Si vous avez des questions ou avez besoin d'aide, n'hésitez pas à ouvrir une issue sur GitHub ou à contacter les mainteneurs du projet.

Greetings

Merci de votre intérêt et de votre contribution à ce projet !