Afin de conserver une coherence dans le code et de faciliter la maintenance voici quelques recommandations qu'il faudra respecter pour contribuer.
##Ajout d'une fonctionnalité
- Cloner le dépot
git clone project_name- Installer le projet
- Choisir une issue à réaliser
- Creer une branche locale en la nommant "feature/nom_de_l'issue"
git checkout -b "feature/nom_de_l'issue"- Ecrire votre code
- Ecrire les tests, une converture de code d'au moins 70% est attendue
- Lancer les tests (le coverage se crée automatiquement dans )
composer test- Analyser le code avec PHPStan et corriger si necessaire
vendor/bin/phpstan analyse -l 5 src/- Ajouter ou modifier la documentation
- Enregistrer votre travail dans un commit
git add .
git commit -m "nom du commit"- Push le code sur le serveur distant
git push --set-upstream origin branch_name- Ouvrir une pull request
##Qualité du code
Lors de l'ouverture d'une pull request une pipeline d'intégration continue se lance afin de réaliser plusieurs actions sur le code et notamment la vérification de la qualité du code. Afin de valider votre PR il est donc nécessaire de valider les étapes d'analyse statique du code, il vous est alors demandé d'utiliser PHPStan ainsi que PHP-cs-fixer.