Changelog et notes de version expliquées pour les non-développeurs

Vous obtenez des mises à jour vers iOS ou Android sur vos smartphones. Les joueurs obtiennent de nouveaux correctifs de contenu pour World of Warcraft ou Call of Duty. Les plugins et thèmes WordPress bénéficient de nouvelles fonctionnalités. Le logiciel que vous utilisez chaque jour est mis à jour périodiquement. Lorsque c'est le cas, un journal des modifications est publié et vous montre exactement ce qui a été corrigé ou ajouté.

Le problème avec ces journaux des modifications vient du fait qu'ils sont souvent très difficiles à lire et à comprendre, à moins que vous ne soyez soit…

• directement impliqué dans le projet
• un développeur de logiciels formé à la lecture de documents techniques et de jargon

Pour la plupart des gens, même la structure d'un journal des modifications est intimidante, ce qui les fait ignorer complètement les notes. C'est mauvais pour un certain nombre de raisons, dont la moindre n'est pas le fiasco des widgets d'affichage et des problèmes similaires (qui sont malheureusement assez courants).

Décrivons donc ce qu'est un journal des modifications, comment lire les notes de version et assurez-vous de rester aussi à jour et informé que possible.

Ton et style

Différentes entreprises et développeurs abordent leurs changelogs différemment. Certains sont simples et vous disent exactement ce que fait la mise à jour en termes techniques, tandis que d'autres (comme vous pouvez le voir dans l'exemple ci-dessous d'une récente mise à jour de Slack) optent pour une approche plus lisible (et souvent humoristique) pour informer les utilisateurs des nouveautés.

Par exemple, WordFence est un plugin de sécurité qui ne peut pas se permettre d'être désinvolte dans ses notes. Trop de gens roulent trop sur eux, tandis que toute la marque Slack consiste à être accessible et amusante.

En général, ce sont les deux types de notes de version que vous verrez. Si vous êtes impliqué dans le développement, cependant, vous verrez des journaux des modifications écrits de manière beaucoup plus obscure. À moins que vous ne fassiez un tour sur Github, vous n'en trouverez probablement pas qui soient totalement incompréhensibles.

L'importance des questions abordées par les changements dicte également le ton. Si Slack, par exemple, était victime d'une violation de données due à une vulnérabilité de code (Dieu nous en préserve), les notes de mise à jour du correctif seraient sombres et rassurantes.

En fin de compte, cependant,

Comprendre les versions ponctuelles et les numéros de version

La structure principale d'un changelog est assez simple. Vous avez un numéro de version composé (généralement) de deux ou trois chiffres séparés par des décimales — 2.39 ou 1.3.37 et une liste à puces de ce qui accompagne chaque version.

Chacun de ces nombres a une fonction spécifique. Nous les décomposerons en termes généraux afin que vous sachiez ce que vous regardez. Parce que vous aurez toujours des notifications indiquant que vous avez une mise à jour en attente.

3.xx

Le premier chiffre d'un journal des modifications indique les versions principales du logiciel, les versions majeures, le nombre de fois où le logiciel a été publié avec des améliorations significatives qui modifient la fonctionnalité globale.

Par exemple, lorsque vous mettez à jour votre iPhone vers iOS 11, vous effectuez techniquement une mise à jour vers la version 11.0.0. Idem lorsque vous obtenez Android Oreo, c'est la version 8.0. Généralement, lorsque le premier numéro d'un logiciel est mis à jour, vous obtiendrez une expérience très différente de celle d'avant.

Si vous êtes un joueur, pensez aux extensions qui sont des versions majeures. La première version de World of Warcraft en 2004 était la version 1.0, tandis que The Burning Crusade était la 2.0, et l'extension actuelle, Legion, était la 7.0.

Avec Divi, la sortie de 2.7 à 3.0 était une refonte du Divi Builder vers le tout nouveau Visual Builder, qui a apporté un gros changement pour tout le monde.

x.1.x

Le deuxième chiffre est l'endroit où vous voyez de nouvelles fonctionnalités ajoutées ou des bogues corrigés. Les deuxième (et troisième) chiffres sont appelés des libérations ponctuelles car ils sont lus à haute voix comme « sept virgule trois virgule quatre ».

Ces ajouts peuvent modifier un aspect de l'application ou du plug-in, mais pas la fonctionnalité de base comme le ferait une version majeure. Lorsque Divi ajoute un nouveau module ou lorsque iOS ou Android ajoute de nouveaux emoji, vous l'aurez en version 3.1 ou 10.3.

Pour les plugins WordPress, jetez un œil à Yoast SEO. La version 5.5.0 apporte quelques corrections de bugs et améliorations, mais il n'y a rien de bouleversant ici. Fondamentalement, vous n'avez pas besoin de réapprendre le fonctionnement du logiciel avec les versions ponctuelles.

Ces versions ponctuelles se produiront lorsque vous obtiendrez de nouveaux niveaux ou systèmes dans les jeux vidéo. Comme vous pouvez le voir ci-dessous, la version 2.2. à 2.3 de l'application mobile Kingdom Hearts a ajouté un système pour animaux de compagnie. Cela ne change pas la façon dont le jeu se joue, mais ajoute quelque chose en plus de ce qui existe déjà.

xx7

Avec le troisième et dernier chiffre des notes de version, votre journal des modifications sera probablement plein de corrections de bugs mineurs (au mieux). Ou probablement des changements/améliorations de fond que vous ne remarquerez probablement pas.

Facebook est connu pour ce genre de publications ponctuelles. Leurs applications sont mises à jour toutes les semaines et elles peuvent changer peu ou rien que (la plupart) des utilisateurs remarqueront avec une utilisation quotidienne.

Souvent, ces versions ponctuelles mineures sont ce qu'on appelle un « correctif ». Ce ne sont que des correctifs qui résolvent un problème dont la plupart des utilisateurs ne connaissent même pas l'existence. La plupart de ces correctifs corrigent quelque chose comme une police cassée sur une certaine version de navigateur. Ou peut-être une fuite de mémoire sur un système d'exploitation spécifique. Souvent, ces correctifs sont étiquetés comme quelque chose de générique comme des « problèmes de compatibilité ».

Parfois, vous obtiendrez un correctif pour un problème que les développeurs considèrent comme quelque chose qui ne peut pas attendre le prochain correctif de contenu (ou une mise à jour régulière). Encore une fois, cela peut ou non vous affecter.

Comme vous pouvez le voir dans les mises à jour apportées à Yoast de 5.3.2 à 5.3.3, les mises à jour sont relativement mineures mais importantes dans « certaines situations ».

Changelog dans la nature

À titre d'exemple, jetez un œil aux notes de version/au journal des modifications de Divi sur quelques versions majeures. Entre 2.7 et 3.0.1, vous pouvez voir les types de modifications qui ont été apportées. Certains majeurs (la sortie du nouveau Visual Builder) et certains mineurs (changements de police pour WordPress 4.6 uniquement).

version 3.0.1 ( updated 09-08-2016 )
- Fixed various third party module conflicts in the Visual Builder.
- The save button will now appear automatically when attempting to leave the Visual Builder without saving.
- Fixed issue with content width misalignment in the Visual Builder while boxed layout was enabled.
- Fixed occurrences where the in-line editor did not save properly
- Added footer credits editor to Theme Customizer.
- Fixed issues with IE11 and the Slider Module when viewed inside the Visual Builder.
- Fixed problem with the rendering of the divider module height setting in the Visual Builder.
	

version 3.0 ( updated 09-07-2016 )
- Introducing the brand new Visual Builder: https://www.elegantthemes.com/blog/theme-releases/divi-3

version 2.7.10 ( updated 08-18-2016 )
- Fixed the issue with the Divi Builder not loading on some websites due to loading delay of TinyMCE in the latest version of WordPress.


version 2.7.9 ( updated 08-15-2016 )
- Fixed settings page font issues in WordPress 4.6

Nous sommes actuellement à la version 3.0.78 au moment d'écrire ces lignes. Jusqu'à présent, les changements ont été des ajouts et des ajustements relativement subtils. Ils sont importants et géniaux, et nous en sommes très fiers, mais ces 78 mises à jour depuis la version 3.0.0 jusqu'à maintenant sont itératives pour améliorer la vie des membres d'Elegant Themes. Quand 3.1 arrive, vous savez que ça va être superbe.

Et 4.0 ? Mec, oh, mec... on ne peut qu'imaginer.

Portez une attention particulière à votre journal des modifications

Vous devez toujours lire le journal des modifications fourni avec toute mise à jour de plugin, d'application ou de thème. Comme il est indiqué dans l'article Wordfence je lien ci - dessus, les plugins ne soient vendus. Même si vous faites confiance au développeur d'origine (et le nouveau peut être tout aussi digne de confiance), vous devez être conscient de ce changement de propriétaire.

Le changelog est l'endroit où vous découvrirez ce genre de chose. Toutes les mises à jour et ajouts ne changeront pas votre expérience. C'est toujours une bonne chose de jeter au moins un coup d'œil sur les notes pour voir ce qui est différent, cependant. Rester informé vaut vraiment les 30 secondes qu'il faut pour relire les notes.

Et voici la chose : si vous ne comprenez pas entièrement ce que vous lisez, ce n'est pas grave. En fait, c'est normal. Un changelog est un document de transparence et un enregistrement, pas une mise à jour trimestrielle ou une newsletter par e-mail.

Bien que cela soit dangereux à dire, mon sentiment est que si vous ne comprenez pas ce qu'il y a dans le journal des modifications, alors ce problème n'a probablement pas d'importance pour vous. (Et s'ils le font, ils comptent aussi pour d'autres personnes, qui peuvent et vont le décomposer pour les autres en ligne.)

L'important est que vous compreniez la structure de base des notes de version. Vous devez savoir ce que signifient les nombres et les termes. Et vous finirez par apprendre à analyser le journal des modifications pour trouver les informations importantes.

Vous n'avez pas besoin d'être un développeur (ou même un technicien) pour utiliser un journal des modifications. Tu dois juste savoir ce que tu recherches.

Vignette de l'article par r.kathesi / shutterstock.com