Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (68 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

98 lines (68 loc) · 2.23 KB

Guide de contribution

Merci d'intéresser à Torrentify-Web-API ! Voici les directives pour contribuer au projet.

Code de conduite

Soyez respectueux et bienveillant avec les autres contributeurs. Nous voulons un environnement inclusif et accueillant pour tous.

Comment contribuer

1. Fork et Clone

git clone https://github.com/votre-username/Torrentify-Web-API.git
cd Torrentify-Web-API
git remote add upstream https://github.com/loteran/Torrentify-Web-API.git

2. Créer une branche

git checkout -b feature/ma-feature
# ou
git checkout -b fix/mon-bug

3. Faire vos modifications

  • Respectez le style de code existant
  • Testez vos changements
  • Écrivez des messages de commit clairs en français

4. Commit et Push

git commit -m "Description claire de vos modifications"
git push origin feature/ma-feature

5. Pull Request

  • Créez une PR vers la branche main
  • Décrivez clairement vos modifications
  • Fournissez des captures d'écran si applicable
  • Attendez la révision

Règles de code

Messages de commit

Utilisez le français pour les messages de commit :

feat: Ajouter nouvelle fonctionnalité
fix: Corriger un bug
docs: Mettre à jour la documentation
refactor: Améliorer le code
perf: Améliorer les performances
style: Changements de format (sans logique)
test: Ajouter ou modifier des tests
chore: Tâches de maintenance

Conventions

  • Utilisez const par défaut, let si modification
  • Indentation : 2 espaces
  • Noms de variables en camelCase
  • Noms de constantes en UPPER_SNAKE_CASE

Types de contributions

🐛 Rapporter un bug

  1. Vérifiez que le bug n'existe pas déjà
  2. Décrivez précisément le comportement attendu vs observé
  3. Fournissez les étapes pour reproduire
  4. Indiquez votre version et environnement

✨ Suggérer une feature

  1. Ouvrez une issue
  2. Décrivez le cas d'usage
  3. Attendez le retour avant de commencer le développement

📚 Améliorer la documentation

  1. Corriger des typos ou clarifier des passages
  2. Ajouter des exemples
  3. Traduire en d'autres langues

Besoin d'aide ?

  • 💬 Ouvrez une discussion
  • 📧 Contactez l'auteur
  • 🐛 Consultez les issues existantes

Merci de votre contribution ! 🙏