L'article explore l'importance des messages de commit clairs et de la documentation complète dans le processus de développement logiciel. L'auteur y décrit sa routine personnelle pour rédiger des messages de commit détaillés et structurés, en utilisant un modèle standard qui inclut le type de modification, la portée, un résumé, une description du problème, la solution apportée, et le contexte supplémentaire. Il souligne également l'impact positif de cette pratique sur la collaboration et la maintenance du code. L'article aborde aussi l'utilisation d'outils comme les hooks Git pour maintenir la qualité des commits et l'intégration de l'IA pour aider à la documentation. Enfin, l'auteur partage son approche pour gérer la documentation à travers différentes étapes du développement, soulignant que ces pratiques sont essentielles pour un développement professionnel efficace.
Tout est dans le titre
Tout est dans le titre
Une approche de documentation vivante, avec une critique de la pratique d'écrire les tests en Gherkin
L'auteur donne de bons conseils sur divers sujets :
- VCS (commits atomiques, etc.),
- adoption d'un standard de code corrigé / validé par PHPCS Fixer,
- utilisation d'outils d'analyse statique (PHPStan, Psalm) et de "mutation testing" (Infection)
- automatisation du déploiement
- living documentation, notamment avec Gherkin
L'auteur explique l'intérêt d'utiliser Asciidoc pour générer sa documentation