Contributing Guidelines¶
Voici quelques lignes directrices pour vous aider à démarrer :
Rapport de bogues¶
Si vous trouvez un bogue, veuillez créer un nouveau ticket (issue) dans notre système de suivi des bogues.
Création d'une issue
Notre suivi de projet est sur github dont voici l'adresse : edu-framework/issues
Assurez-vous d'inclure :
- Un titre clair et descriptif
- Les étapes pour reproduire le bogue
- Le comportement attendu
- Le comportement réel
- Tous les journaux ou messages d'erreur pertinents
Proposition de fonctionnalités¶
Si vous avez une idée pour une nouvelle fonctionnalité, veuillez créer un nouveau ticket (issue) dans notre système de suivi des bogues.
Création d'une issue
Notre suivi de projet est sur github dont voici l'adresse : edu-framework/issues
Assurez-vous d'inclure :
- Un titre clair et descriptif
- Une description détaillée de la fonctionnalité proposée
- Tous les cas d'utilisation ou exemples pertinents
- Tous les inconvénients potentiels ou limitations
Pull Requests¶
Avant de soumettre une pull request (PR), veuillez vous assurer :
- Que votre code respecte nos normes de codage (voir ci-dessous)
- Que vos modifications sont bien documentées
- Que vous avez ajouté des tests pour toute nouvelle fonctionnalité
- Que vous avez exécuté tous les tests existants et que vous avez vérifié qu'ils réussissent
Normes de codage¶
Notre projet utilise les normes de codage PSR-2. Veuillez vous assurer que votre code respecte ces normes avant de soumettre une pull request.
De plus, veuillez vous assurer que votre code est bien organisé, facile à lire et bien commenté.
Des controleurs de qualité de code sont mis en place pour vérifier que les normes de codage sont respectées.
- PHPStan : vérifie la qualité du code PHP
- PHP Code Sniffer : vérifie la qualité du code PHP
- PHP Mess Detector : vérifie la qualité du code PHP
- PHPMD : vérifie la qualité du code PHP
- SQLint : vérifie la qualité du code SQL
- Trivy : vérifie la qualité des dépendances
Dashboard de qualité de code
Voir le dashboard de qualité de code : Quality Dashboard Codacy
Code de conduite¶
Notre projet suit le Code de conduite. Veuillez le lire avant de contribuer à notre projet.
Merci pour vos contributions !