contributing.md

Contribuer au dépôt de formation

Merci de considérer la possibilité de contribuer à ce dépôt de formation ! En participant, vous contribuez à améliorer la qualité et l'accessibilité du contenu éducatif pour la communauté.

Comment contribuer

Signaler des problèmes

Si vous rencontrez un problème ou un bug avec le matériel de formation, merci de suivre ces étapes :

1. Vérifiez les problèmes existants : Avant d'ouvrir un nouveau problème, assurez-vous que celui-ci n’a pas déjà été signalé.
2. Fournissez des informations détaillées :
   • Description du problème : Une explication claire et concise du problème.
   • Étapes pour reproduire (si applicable).
   • Détails sur l'environnement (par exemple, OS, version, outils utilisés).
   • Captures d'écran (si applicable).

Soumettre des modifications

Nous accueillons toutes les améliorations des matériaux de formation, y compris les corrections de bugs, les mises à jour et les nouvelles fonctionnalités. Merci de suivre ces étapes :

1. Forker le dépôt : Créez une copie personnelle du dépôt sur GitHub.

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

   git clone https://github.com/votre-username/depot-formation.git

3. Créez une nouvelle branche : Il est préférable de créer une branche distincte pour chaque contribution.

   git checkout -b votre-branche

4. Apportez vos modifications : Travaillez sur les mises à jour que vous souhaitez proposer. Assurez-vous de suivre la structure et le formatage des documents existants.

5. Rédigez des messages de commit clairs : Rédigez des messages de commit concis et descriptifs expliquant vos modifications.

   git commit -m "Décrivez vos changements"

6. Poussez vos modifications : Poussez la branche vers votre dépôt forké.

   git push origin votre-branche

7. Créez une pull request : Rendez-vous sur le dépôt original et créez une pull request. Fournissez une description claire des changements dans la pull request.

Guide de style et de formatage

• Formatage Markdown : Assurez-vous que vos contributions sont correctement formatées en utilisant du Markdown. Merci de vous référer aux fichiers existants pour garantir la cohérence.
• Exemples de code : Si vous ajoutez des exemples de code, assurez-vous qu'ils soient bien commentés et respectent les normes de codage pour faciliter leur lecture.
• Nommage des fichiers : Suivez les conventions de nommage utilisées dans le dépôt.
• Tests : Si cela est applicable, ajoutez des tests pour vos modifications. Vous pouvez les placer dans le répertoire tests/.

Notes supplémentaires

• Aide à la documentation : Si vous contribuez à la documentation, assurez-vous que vos modifications soient faciles à suivre et expliquent clairement les concepts pour les apprenants de tous niveaux.
• Retour sur le matériel de formation : Si vous avez des suggestions ou des idées pour de nouveaux sujets ou des améliorations, n'hésitez pas à ouvrir un problème !

Merci pour vos contributions et pour aider à améliorer ces matériaux de formation pour tout le monde !