Ce qu'il faut faire | Pourquoi il faut le faire |
---|---|
Mettre en en-tête de fichier le chemin/dans/le/projet/nomDuFichier.typ | identifier facilement où il est lors d'un MergeRequest, une revue de code, un extrait pour une demande d'aide entre nous ou sur un forum… |
Une ressource précieuse:
Politique de contribution open source de l'État
Lors de mon apprentissage du Python (fin 2016), je trouve assez heureuse la large standardisation de sa convention de codage:
https://docs.python.org/2/faq/design.html
C'est par ce biais que j'ai découvert celle du noyau Linux:
https://www.kernel.org/doc/html/latest/process/coding-style.html
Cela complète la lecture du §5 Mise en forme du livre “Coder proprement” de Robert C.Martin ISBN: 978-2-7440-2583-9
Pas d'articles sur Wikipédia fr mais celui-ci :
https://en.wikipedia.org/wiki/Coding_conventions
Et pour les commits : les préfixes fix:, feat:, refactor:, chore:(fourre-tout), doc:, …, et BREAKING CHANGE qui implique un changement de version majeur
conventionalcommits.org