[Olena-patches] De l'art du ChangeLog (Was: 1822: Clean up some ChangeLog entries.)

En relisant certaines entrées de ChangeLog, je m'aperçois qu'il y a du relâchement ! Certaines entrées sont bâclées, voire non remplies ! Ce n'est pas admissible. Olena n'est pas un projet kleenex, on a besoin que vous remplissiez les ChangeLog correctement et précisément pour 1. suivre l'activité du projet en général ; 2. suivre votre travail en particulier ; 3. retrouver l'information plus tard (typiquement, dans plusieurs semaines/mois/années), ce qui est capital (et beaucoup plus courant que vous ne le pensez). Merci de lire attentivement ce qui suit, et de mettre en pratique ! * La première chose à faire est de revoir les fondamentaux. Relisez donc : - https://www.lrde.epita.fr/dload/guide/guide.html#htoc66 - http://www.gnu.org/prep/standards/html_node/Change-Logs.html * Ensuite, regardez comment les autres entrées de ChangeLog sont écrites. Vous pouvez prendre exemple sur Akim, Alexandre, Théo et moi-même, qui avons l'habitude de cet exercice. * Les outils sont là pour vous aider. En particulier, Emacs peut vous aider à pré-remplir un ChangeLog plus facilement avec le mode ad hoc : M-x change-log-mode Pour éviter les lignes-qui-dépasse-les-80-colonnes, utilisez M-x auto-fill-mode Quant aux problèmes d'espace (à traiter directement sur le fichier ChangeLog dans un patch à part, le cas échéant), utilisez M-x whitespace-cleanup * Corrigez vos erreurs de ChangeLog au plus vite (i.e., pas trop lomgtemps après le patch contenant ces erreurs), *dans un patch séparé* et *ne faites pas mention de ces changements dans le ChangeLog lui-même* ! Pour cela, il vaut mieux éviter d'utiliser Vcs ou svn-wrapper : utilisez « \svn » au lieu de « svn » pour déconnecter temporairement votre alias « svn » : \svn commit -m "Clean up ChangeLog" ChangeLog Puis n'oubliez pas de poster les changements ; par ex. : svn diff -r PREV >diffs.patch et postez diffs.patch dans olena-patches(a)lrde.epita.fr dans un message qqch qui ressemble à ce que génerent Vcs et svn-wrapper. * Enfin, voici quelques erreurs classiques, qu'il ne *faut pas* repoduire. Merci d'avance ! Attention à l'indentation: dans ChangeLog, les lignes correspondant aux fichiers démarrent par une tabulation (C-i), puis par une étoile (*) et une espace, et enfin le nom du fichier. Prière de ne pas faire du cinémascope (plus de 80 colonnes), tant dans le code que dans les ChangeLogs. [...] Attention aux majuscules, et à la ponctuation en général. [...] Remplir *toutes* les lignes! Laisser des ligne vides est inadmissible. Attention aux espaces. Utiliser les idiomes des ChangeLogs. Lorsque vous voulez parler d'un individu `bar' (une fonction, par ex.) dans un fichier `foo.cc' par exemple, ne faites pas ça : * foo.cc: Add a new function `bar'. Mais faites ceci : * foo.cc (bar): New function.