DeveloppementBonnesPratiques » Historique » Version 4
« Précédent -
Version 4/22
(diff) -
Suivant » -
Version actuelle
Daniel Dehennin, 13/09/2016 11:56
Bonnes Pratiques de Développement¶
Style de code commun¶
- Éditor config (même configuration des éditeurs de code)
Développement piloté par les tests¶
Le Test driven development préconise d’écrire les tests unitaires avant d’écrire le code source:
- Écrire un premier test ;
- Vérifier qu'il échoue (car le code qu'il teste n'existe pas), afin de vérifier que le test est valide ;
- Écrire juste le code suffisant pour passer le test ;
- Vérifier que le test passe ;
- Puis réusiner le code, c'est-à-dire l'améliorer tout en gardant les mêmes fonctionnalités.
Documentation d’API automatique¶
- Génération de la documentation d'API depuis le code (docstring)
Modèle de développement avec Git¶
Utiliser Gitflow
- Git flow: intégration des fonctionnalités si
- les tests passent
- le code est relu (Gerrit)
Qualité du code¶
- Qualité du code (PyLint / JSLint)
- Couverture des tests
- Couverture de la doc : vérifier que toute l'API est documentée
Intégration continue¶
- Intégration continue : exécution automatique des tests (jenkins)