Les messages de validation doivent-ils être écrits au présent ou au passé?

Question

Alors, quelle est selon vous la meilleure et la plus intuitive?

 Fixed the XXX bug in YYY
Fix the XXX bug in YYY
Fixes the XXX bug in YYY
Fixing the XXX bug in YYY
 

Veuillez fournir vos justifications. Note Je vous demande de votre point de vue général, ce qui signifie que vous ne devriez pas essayer d'associer cela aux outils svn / cvs ou aux langages de programmation que vous préférez, mais plutôt à quelque chose qui devrait / peut être appliqué à tous les outils et langages de programmation.

Answer 1

Je vais personnellement avec le passé ("fixe") car au moment où j'arrive à commettre le bug est corrigé (ou je ne commettrais pas).

Answer 2

Je préfère voir les messages de validation au présent. De cette façon, le message décrit ce que fait le diff (parce que vous pouvez extraire ce diff ou même l’engager dans une branche différente). Ainsi, le message de validation ne décrit pas ce qu'il a "fait" ... Il décrit ce que fait le commit lui-même. Donc, il devrait être au présent.

Imaginez que vous examinez un diff de manière isolée et que vous essayez de décider si vous l'appliquerez. Cela n'a aucun sens d'avoir un titre au passé.

Answer 3

À mon humble avis, si vous voulez qu'il soit descriptif sans nécessité de tenir compte du contexte, puis "Fixe" est certainement la seule variante.

Quant à l'intuition - si je regarde un changelog, je vais certainement comprendre que vous voulez dire la correction d'un bug que je sais que le contexte dans lequel le mot est utilisé, mais mon cerveau va l'attraper beaucoup plus rapidement si le mot est écrit dans le cadre de cette spécification.

"Fixation" est le plus mauvais choix à mon humble avis, car il peut être interprété non seulement comme décrivant ce que le patch n'est (est), mais comme un état de bogue ainsi ce qui voudrait dire qu'il est en cours d'élaboration et n'est pas encore résolu.

Answer 4

Fix the XXX bug in YYY
Teach the XXX to be more ZZZ
Correct typos in javadoc

En général: {impératif du verbe} {objet affecté} {facultatif qualificatifs}

Un impératif s'adapte à tous les cas d'utilisation quand je suis en train d'étudier un nouveau jeu de patches.

• Qu'allez-vous faire ici?
• Quel est ce nouveau jeu de patches?
• Pourquoi ce nouveau jeu de patches créé? (pour fixer le xxx bug...)
• J'ai besoin de fixer le xxx bug dans yyy. Est-il s'engager sur une autre branche qui fait déjà?

Quel que soit votre choix, je trouve que la consistance vous aide à la lisibilité énormément. Choisissez-en un et de rester avec elle.