🛠️ Guide de Contribution
Merci de votre intérêt pour ce projet ! Ce guide a pour objectif de faciliter la contribution en expliquant les bonnes pratiques et les étapes à suivre.
📦 Pré-requis
- Un compte GitHub
- Git installé localement
- (Facultatif) Un environnement Python/JS selon le type de contribution
🔄 Workflow de contribution
- Fork du dépôt
- Clone de votre fork
git clone https://github.com/votre-utilisateur/nom-du-projet.git
cd nom-du-projet
- Création d’une branche dédiée
git checkout -b feature/ma-contribution
-
Développement ou modification
- Respectez la structure du projet
- Commentez votre code si nécessaire
- Ajoutez des références ou liens utiles
-
Commit clair et structuré
git commit -m "feat: ajoute X selon l’issue #42"
- Push de votre branche
git push origin feature/ma-contribution
- Création de la Pull Request (PR)
- Décrivez vos modifications
- Reliez la PR à une issue (
Fixes #42) - Mentionnez tout élément à discuter
✅ Tests et validation
Avant de soumettre une PR :
- Vérifiez que la compilation / génération fonctionne (
mkdocs build,npm run build, etc.) - Lisez-vous vous-même pour détecter fautes et oublis
- Faites une revue rapide de vos commits
✨ Bonnes pratiques
- Favorisez des PR courtes et ciblées
- Rédigez en français ou anglais selon le contexte du dépôt
- Soyez bienveillant dans vos échanges
- Posez vos questions dans les issues si vous avez un doute
📚 Ressources utiles
📬 Me contacter
Pour toute question, remarque ou suggestion, vous pouvez me contacter directement via GitHub @vincentlagny ou ouvrir une discussion dans l’onglet Discussions du projet.
Merci de contribuer à rendre ce projet plus solide, plus inclusif et plus utile pour tous !