Skip to Content
Wagoo SaaS 1.0.25 is released 🎉
08 DevelopmentContributingContributing

Contributing

Guide pour contribuer au projet Wagoo.

Code of Conduct

Soyez respectueux et inclusif.

  • Pas de discrimination
  • Pas d’harcèlement
  • Soyez bienveillant

Avant de commencer

  1. Forkez le repository
  2. Clone votre fork localement
  3. Créez une branche
git clone https://github.com/your-username/wagoo.git cd wagoo git checkout -b feature/my-feature

Type de contributions

Bugs

  1. Ouvrez une issue avec le titre “BUG: …”
  2. Décrivez le problème
  3. Étapes pour reproduire
  4. Comportement attendu vs actuel

Features

  1. Ouvrez une issue avec le titre “FEATURE: …”
  2. Décrivez l’idée
  3. Cas d’usage
  4. Exemples

Documentation

  1. Modifiez directement les fichiers .mdx
  2. Créez une PR avec vos changements

Processus de PR (Pull Request)

1. Commit message

Suivez la convention :

type(scope): subject body footer

Types :

  • feat: nouvelle feature
  • fix: correction de bug
  • docs: documentation
  • refactor: refactoring
  • test: tests
  • chore: config/dependencies

Exemples :

feat(auth): add two-factor authentication Adds TOTP-based 2FA support using speakeasy. Closes #123 fix(api): handle null user gracefully refactor(components): extract Button styles to util docs(guide): update stripe setup instructions

2. Formatage

# Avant de commit pnpm lint:fix pnpm format # Vérifier pnpm lint pnpm test

3. Tests

Ajouter des tests pour vos changements :

# Lancer les tests pnpm test # Avec coverage pnpm test --coverage

4. Push et PR

git push origin feature/my-feature

Allez sur GitHub → Create Pull Request

Remplissez le template :

## Description Changements apportés... ## Type - [ ] Bug fix - [ ] New feature - [ ] Documentation ## Related issues Closes #123 ## Testing Comment tester vos changements ## Screenshots Si applicable

Revue de code

Quand vous recevez des commentaires

  1. Discutez si vous n’êtes pas d’accord
  2. Apportez les changements demandés
  3. Push les changements (mĂŞme branche)
  4. Marquez comme résolu

Évaluer une PR

  1. Clone la branche
  2. Testez localement
  3. Lisez le code
  4. Laissez des commentaires constructifs

Sections du projet

Pour débuter

  • docs/ - Documentation - changements faciles
  • README.md - Guide de setup
  • CONTRIBUTING.md - Ce fichier

Intermédiaire

  • Bugs labellisĂ©s “good first issue”
  • Refactoring de code existant
  • Tests manquants

Avancé

  • Nouvelles features architecturales
  • Performance optimizations
  • IntĂ©grations externes

Processus de release

Version numbering

Suit Semantic Versioning :

MAJOR.MINOR.PATCH 1.2.3
  • MAJOR : changements incompatibles
  • MINOR : nouvelles features
  • PATCH : bug fixes

Exemples :

1.0.0 → 1.1.0 : nouvelle feature 1.1.0 → 1.2.0 : plusieurs features 1.0.0 → 2.0.0 : breaking changes 1.0.0 → 1.0.1 : bug fix

Discussions

Discord/Slack

Rejoignez le serveur Wagoo pour :

  • Parler des idĂ©es
  • Poser des questions
  • Collaborer en temps rĂ©el

Recognition

Tous les contributeurs sont listé dans :

  • CONTRIBUTORS.md
  • Release notes
  • Site principal

Merci pour votre contribution!

Troubleshooting contributions

”My PR is not being reviewed”

  • Assurez-vous que les tests passent
  • Attendez quelques jours (les reviewers sont bĂ©nĂ©voles)
  • Ping respectueusement sur Discord

”I disagree with a review comment”

  1. Expliquez respectueusement votre point de vue
  2. Cherchez un consensus
  3. Si désaccord, demandez un 2ème avis

”Merge conflict”

# Récupérer les changements de main git fetch origin main git rebase origin/main # Résoudre les conflits # Puis force push git push origin feature/my-feature --force-with-lease

Ressources

Support

Questions?

  • Ouvrez une issue
  • Demandez sur Discord
  • Contactez @wagoo-team

Merci de contribuer!

Last updated on