DeveloppementBonnesPratiques » Historique » Version 5
Version 4 (Daniel Dehennin, 13/09/2016 11:56) → Version 5/22 (Daniel Dehennin, 13/09/2016 11:59)
h1. Bonnes Pratiques de Développement
h2. Style de code commun
* Éditor config (même configuration des éditeurs de code)
h2. Développement piloté par les tests
Le "Test driven development":https://fr.wikipedia.org/wiki/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.
h2. Documentation d’API automatique
* Génération de la documentation d'API depuis le code (docstring)
h2. Modèle de développement avec Git
Utiliser le modèle de développement "Gitflow":http://nvie.com/posts/a-successful-git-branching-model/. "Gitflow":http://nvie.com/posts/a-successful-git-branching-model/
La version "AVH":https://github.com/petervanderdoes/gitflow-avh du logiciel *@gitflow@* est celle fournie par défaut sur Debian et Ubuntu, elle est maintenue contrairement à la version originelle.
* Git flow: intégration des fonctionnalités si
** les tests passent
** le code est relu (Gerrit)
h2. Qualité du code
* Qualité du code (PyLint / JSLint)
* Couverture des tests
* Couverture de la doc : vérifier que toute l'API est documentée
h2. Intégration continue
* Intégration continue : exécution automatique des tests (jenkins)
h2. Déploiement d'environnements de Dev (Vagrant?)
h2. Style de code commun
* Éditor config (même configuration des éditeurs de code)
h2. Développement piloté par les tests
Le "Test driven development":https://fr.wikipedia.org/wiki/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.
h2. Documentation d’API automatique
* Génération de la documentation d'API depuis le code (docstring)
h2. Modèle de développement avec Git
Utiliser le modèle de développement "Gitflow":http://nvie.com/posts/a-successful-git-branching-model/. "Gitflow":http://nvie.com/posts/a-successful-git-branching-model/
La version "AVH":https://github.com/petervanderdoes/gitflow-avh du logiciel *@gitflow@* est celle fournie par défaut sur Debian et Ubuntu, elle est maintenue contrairement à la version originelle.
* Git flow: intégration des fonctionnalités si
** les tests passent
** le code est relu (Gerrit)
h2. Qualité du code
* Qualité du code (PyLint / JSLint)
* Couverture des tests
* Couverture de la doc : vérifier que toute l'API est documentée
h2. Intégration continue
* Intégration continue : exécution automatique des tests (jenkins)
h2. Déploiement d'environnements de Dev (Vagrant?)