Règles concernant les Pull Requests

Pour assurer un processus d'examen fluide et efficace, les contributeurs et les examinateurs doivent adhérer aux règles suivantes lorsqu'ils soumettent et examinent des pull requests (PRs)

Pour les contributeurs

1. Titres et descriptions descriptifs
   • Utilisez des titres clairs et concis qui résument les changements.
   • Donnez des descriptions détaillées de ce que la PR fait, pourquoi les changements sont nécessaires, et aussi tout contexte pertinent à savoir.
2. Lien vers les issues
   • Dans le titre de votre PR, ajoutez GH-ISSUE-NUMBER pour lier la PR à l'issue correspondante. Ceci est requis pour toutes les PRs.
3. Changements petits et ciblés
   • Visez à garder les PRs de petite taille et ciblée sur une seule issue ou fonctionnalité. Ce qui permet aux examinateurs de plus facilement comprendre et faire des retours.
4. Qualité du code
   • Assurez-vous que votre code suive les standards de programmation du projet et les bonnes pratiques.
   • Ajoutez des commentaires quand c'est nécessaire pour expliquer les logiques complexes.
   • Testez toujours vos modifications localement avant de soumettre la PR afin de détecter les problèmes le plus tôt possible.
   • Formatez votre code en utilisant le format bun pour maintenir la cohérence dans l'ensemble dans la codebase.
5. Tests
   • Testez rigoureusement vos changements avant de soumettre une PR.
   • Si possible, incluez des tests unitaires ou des tests d'intégration pour valider vos changements
6. Documentation
   • Mettez à jour ou ajoutez de la documentation si besoin, qui reflète vos changements.
7. Messages de commit
   • Utilisez des messages de commit clairs et descriptifs qui suivent le format de convention Commits conventionnels.
8. Vérifiez les conflits
   • Avant de soumettre votre PR, assurez-vous que votre branche est à jour avec la branche de base pour minimiser les conflits de fusions.

Pour les examinateurs

• Vous être supposés examiner les PRs rigoureusement, et demander des changements si nécessaire.
• Fournissez des commentaires constructifs et des suggestions d'amélioration.
• Vérifiez que les changements sont en accord avec les standards de programmation du projet et les bonnes pratiques.
• Déployez la PR en utilisant l'intégration dokploy pour s'assurer que les changements fonctionnent comme prévu.
• Assurez-vous que la documentation est mise à jour si besoin.
• Approuvez la PR seulement si vous êtes satisfaits des changements et que toutes les vérifications sont validées.