notes-techniques/CONTRIBUTING.md

🤝 Contribution au projet

Merci de votre intérêt pour ce projet ! Ce guide explique comment contribuer efficacement.

🚀 Comment contribuer ?

1️⃣ Forker et cloner le dépôt

1. Forkez le dépôt sur votre compte Git.
2. Clonez-le en local :

   git clone https://git.abonnel.fr/cedricAbonnel/notes-techniques.git
   cd notes-techniques
   

2️⃣ Créer une branche

Avant de faire vos modifications, créez une nouvelle branche :

git checkout -b feature/nom-de-votre-feature

Remplacez nom-de-votre-feature par une description claire de votre ajout ou correction.

3️⃣ Développer et tester

• Assurez-vous que votre code respecte la structure existante.
• Testez vos scripts avant de proposer une modification.
• Documentez vos changements si nécessaire (ajout d'explication dans README.md ou INSTALL.md).

4️⃣ Soumettre une Pull Request (PR)

1. Ajoutez et validez vos changements :

   git add .
   git commit -m "Ajout d'une fonctionnalité X"
   

2. Poussez votre branche :

   git push origin feature/nom-de-votre-feature
   

3. Créez une Pull Request depuis l'interface Git en expliquant vos changements.

📌 Bonnes pratiques

• Code clair et lisible : Commentez si nécessaire.
• Respect de la structure : Gardez les fichiers organisés.
• Petites PRs bien définies : Une PR = une seule amélioration claire.
• Discussions ouvertes : N'hésitez pas à poser des questions ou à proposer des idées.

🛠 Signaler un problème

Si vous trouvez un bug ou avez une suggestion, ouvrez une issue avec :

• Une description claire du problème
• Les étapes pour le reproduire
• Le comportement attendu

Merci pour votre contribution ! 🚀