Skip to content

Latest commit

 

History

History
86 lines (53 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

86 lines (53 loc) · 2.95 KB

Contribuer à FabRice

Nous apprécions votre intérêt à contribuer à FabRice! Que vous soyez un développeur expérimenté ou un débutant, toutes les contributions sont les bienvenues. Ce guide vous aidera à commencer et à vous assurer que votre contribution est utile et bien intégrée.

Comment contribuer

1. Proposer des idées et signaler des problèmes

  • Si vous avez des idées pour améliorer FabRice ou si vous avez trouvé un bug, veuillez ouvrir un issue.
  • Assurez-vous de vérifier les issues existants avant d'en créer un nouveau pour éviter les doublons.

2. Fork et clone le dépôt

  1. Fork le dépôt officiel FabRice.
  2. Clonez votre fork localement :
git clone https://github.com/<votre-utilisateur>/FabRice.git
cd FabRice

3. Créez une branche

Créez une nouvelle branche pour vos modifications :

git checkout -b feature/nouvelle-fonctionnalité

4. Faites vos modifications

Apportez vos modifications ou ajouts dans votre branche. Assurez-vous de suivre les directives de style de code du projet et d'inclure des tests si nécessaire.

5. Commitez vos changements

Commitez vos modifications avec un message de commit clair et descriptif :

git add .
git commit -m "Ajouter une nouvelle fonctionnalité pour [ce qu'elle fait]"

6. Poussez vos modifications

Poussez vos modifications vers votre fork :

git push origin feature/nouvelle-fonctionnalité

7. Ouvrez une Pull Request

  1. Allez sur la page de votre fork sur GitHub.
  2. Cliquez sur le bouton "Compare & pull request".
  3. Décrivez vos modifications et soumettez la Pull Request.

Directives de codage

Style de code

  • Utilisez des noms de variables et de fonctions clairs et descriptifs.
  • Suivez les conventions de style de code utilisées dans le projet.
  • Indentez votre code correctement.

Documentation

  • Mettez à jour la documentation correspondante si vous apportez des modifications qui nécessitent une documentation.
  • Assurez-vous que le code est bien commenté pour expliquer les parties complexes ou importantes.

Tests

  • Ajoutez des tests pour les nouvelles fonctionnalités et assurez-vous que les tests existants passent.
  • Utilisez des cas de test significatifs et variés pour couvrir différents aspects de la fonctionnalité.

Revue de code

Tous les changements passeront par une revue de code. Un ou plusieurs mainteneurs du projet examineront votre Pull Request et pourront demander des modifications avant de l'accepter. Soyez prêt à discuter et à affiner votre code.

Ressources supplémentaires

Merci encore pour votre contribution! Ensemble, nous pouvons améliorer FabRice et en faire un projet encore plus incroyable.