Accès direct au contenu Accès direct à la navigation

Ce document développe les règes que nous suivons aux Ateliers pour rédiger les fichiers "Changelog" (liste des évolutions) et nos messages de commit.

Un script shell est proposé avec les outils de Console de notre dépôt de référence.

Messages de commit

Nos messages de commit DOIVENT être rédigés en anglais et suivre la construction suivante :

A short title for the commit changes (less than 80 characters)

And, after a blank line, the full description of the changes, that can be ...

... on multiple lines ...

And contains an infos like :
Bug : URL or ID
Fix #ID

Pour ouvrir un éditeur de texte depuis la ligne de commande pour rédiger un message de commit, utilisez la commande :

  1. ~$ git commit

Changelog

Ces règles sont inspirées (mais ne suivent pas strictement) les règles de Changelog du projet GNU.

Pour écrire un fichier de Changelog, il est important d’identifier les versions concernées. Nous devons séparer chaque bloc de modifications par les versions concernées, dument identifiées, comme les tags dès lors qu’ils sont définis par un numéro de version majeur ET mineur. Le résultat global devrait avoir la forme suivante :

version X.Y.Z(n) - date
=======================

the list of changes from old version to this one

version X.Y.Z(n-1) - date
=========================

...

Une liste de changements est une liste de commits, organisés par date et incluant pour chacun d’eux : son titre, son auteur, la date et l’heure du commit, son ID abbrévié (hash) et le message complet du commit. Chaque ligne ne doit pas dépasser 80 caractères (les couper si besoin).

2013-03-29

* test for commit message rules
Piero Wbmstr  e-piwi.fr> | 2013-03-29 23:39:08 +0100 | 262e522
mqlskdjf jkqmsldfjqmlsdkjf jkMLkjqk sdjfmlqksdjfmlqksdjmflk JKMlkjqks
djfmqlsdkfjmLKJmlkjqsdf

qsdfmlkj JKLmkj jmlkjqsdf

See bug : #2345

* Including a Profiler in the global template with page and system infos
PïeroWbmstr  e-piwi.fr> | 2013-03-29 11:01:25 +0100 | 55d0e02

* wip ...
Piero Wbmstr  e-piwi.fr> | 2013-03-29 09:24:35 +0100 | 651630a

2013-03-28

* Oups, a forgotten template for search results
PïeroWbmstr  e-piwi.fr> | 2013-03-28 12:04:27 +0100 | 091dab7