👩🧑‍💻 Contributing Guidelines / Guide de contribution

Thanks for your interest in contributing to this project!
Merci de votre intérêt pour ce projet !

To ensure a consistent and collaborative workflow, please follow these guidelines.
Pour assurer un flux de travail cohérent et collaboratif, veuillez suivre ces règles.

✅ Minimum Requirements for Every Pull Request (PR)

✅ Exigences minimales pour chaque Pull Request (PR)

Your code must meet these criteria before it can be merged into the main branch:
Votre code doit répondre à ces critères avant d'être fusionné dans la branche main :

Peer Review Required
Révision par un pair requise
Every PR must be reviewed and approved by at least one other student. You may not approve your own PR.
Chaque PR doit être relue et approuvée par au moins un autre étudiant. Vous ne pouvez pas approuver votre propre PR.
Tests Must Pass
Les tests doivent réussir
All tests must pass before merging. If your code breaks something, fix the issue before requesting review.
Tous les tests doivent réussir avant la fusion. Si votre code brise quelque chose, corrigez le problème avant de demander une révision.
New Code Must Include Tests
Tout nouveau code doit inclure des tests
Add unit or integration tests for new features. If you’re unsure how, ask for help in your PR.
Ajoutez des tests unitaires ou d’intégration pour les nouvelles fonctionnalités. Si vous ne savez pas comment faire, demandez de l’aide dans votre PR.
Test Coverage Should Not Decrease
La couverture de tests ne doit pas diminuer
Coverage must stay the same or improve. Small decreases may be acceptable with justification.
La couverture doit rester stable ou s’améliorer. De légères diminutions peuvent être acceptées avec justification.
Keep PRs Small and Focused
Gardez les PR petites et ciblées
Submit pull requests that are small enough to review easily. Big PRs are harder to review and more likely to be rejected or delayed.
Soumettez des PR assez petites pour être faciles à relire. Les grosses PR sont plus difficiles à revoir et peuvent être retardées ou refusées.
Pre-merge with Main Before Approval
Fusionnez avec main avant d’être approuvé·e
Make sure your branch is up to date with main before requesting review.
Don’t leave merge conflicts for the reviewer to resolve.
Assurez-vous que votre branche est à jour avec main avant de demander une révision.
Ne laissez pas les conflits de fusion à la personne qui approuve.

📁 Branching and Workflow

📁 Branches et flux de travail

Work on a feature branch (not main).
Travaillez sur une branche dédiée (pas directement sur main).
Use descriptive branch names: feature/login, fix/typo, etc.
Utilisez des noms de branche explicites : feature/login, fix/typo, etc.

🧪 Running and Writing Tests

🧪 Exécuter et écrire des tests

Run tests locally before pushing.
Exécutez les tests localement avant de pousser.
Follow the project's testing tools (e.g., Jest).
Suivez les outils de test du projet (ex. Jest).
Write small, clear tests that reflect the expected behavior, even for React pages.
Écrivez des tests simples et clairs reflétant le comportement attendu, même pour les pages React.

🤝 Respect and Collaboration

🤝 Respect et collaboration

Be constructive in code reviews.
Soyez constructif dans les revues de code.
Ask questions and give helpful feedback.
Posez des questions et donnez des commentaires utiles.
Don’t approve PRs unless they meet the minimum requirements.
N’approuvez pas les PR si elles ne répondent pas aux exigences minimales.

💬 Need Help?

💬 Besoin d’aide ?

Open a discussion or ask in the issue comments.
Ouvrez une discussion ou posez votre question dans les commentaires d’un ticket.

We’re all learning—no question is too small.
Nous sommes tous en apprentissage—aucune question n’est trop simple.

Thank you for helping us build this project!
Merci de contribuer à ce projet !

4.2 KiB Raw Blame History Unescape Escape