Patch-notes & Versioning — Documenter ses commits

?

Pourquoi tenir un patch-note ?

Quand tu travailles sur un projet, tu vas faire des dizaines de modifications. Sans notes, dans 3 mois tu ne te souviendras plus de ce que tu avais changé entre la version 1 et la version 2 ! Le patch-note est un fichier texte qui garde trace de toutes les versions et de toutes les nouveautés.

🎮

Tu connais les mises à jour de jeux vidéo ? Quand un jeu se met à jour, il y a toujours une liste qui dit "v1.2.0 — nouveau personnage ajouté, bug du menu corrigé, équilibrage des armes". C'est exactement ça un patch-note ! Et bien, ton projet mérite la même rigueur que les grands studios de jeux.

💡Le patch-note sert aussi à communiquer avec les utilisateurs (ou ton prof !) : ils voient clairement ce qui a changé entre chaque version sans avoir à lire tout ton code.

V

Les numéros de version : comment ça marche ?

Un numéro de version s'écrit avec trois chiffres séparés par des points : v0.00.1. Chaque chiffre a une signification précise !

v1.00.0

Majeure

Changement énorme.
Nouvelle étape du projet.
Peut casser la version précédente.

v0.01.0

Mineure

Ajout d'une nouvelle fonctionnalité.
Le projet reste compatible.
Tout continue de fonctionner.

v0.00.1

Patch

Petite correction ou
modification mineure.
Début ou retouche.

⚠️Quand tu augmentes un chiffre, tous ceux à droite repassent à zéro. Exemple : après v0.00.9 vient v0.01.0 (et non v0.00.10). Après v0.09.0 vient v0.10.0.

🚀

v0 vs v1 : le sens des grandes versions

Le chiffre de version majeure (le tout premier) indique à quel stade de maturité se trouve ton projet :

🔬

v0.xx.x

Prototype / En développement.
Le projet n'est pas fini.
Alpha (v0.0x) = premiers tests.
Beta (v0.1x+) = testable par d'autres.
Les choses peuvent changer radicalement.

🎉

v1.00.0

Version publique.
Le projet est présentable.
Les fonctionnalités principales sont là.
Tu es prêt à le montrer au monde.
Stabilité garantie.

v0.00.1

🌱 Début du projet

Structure de base créée, fichiers initiaux

v0.00.2

🎨 Ajout de la navigation

Header et menu créés

v0.01.0

✨ Nouvelle section : galerie

Première fonctionnalité majeure ajoutée

v0.01.1

🐛 Correction affichage mobile

Bug sur petits écrans corrigé

v0.02.0

📬 Formulaire de contact

Deuxième grosse fonctionnalité

v1.00.0

🎉 Mise en ligne officielle

Projet complet et présentable au public !

📋

Créer le fichier patch-note.txt

Le fichier patch-note.txt se place à la racine de ton projet (au même niveau que ton index.html). Il est écrit en texte simple, sans code. Voici le format à suivre :

📋 patch-note.txt

============================================================ MON-SITE — PATCH NOTES Projet : Portfolio personnel ============================================================ [ v0.00.1 ] — 2025-01-14 DÉMARRAGE DU PROJET + Création de la structure de base du projet + Ajout de index.html avec le squelette HTML + Ajout de Assets/css/style.css (vide pour l'instant) [ v0.00.2 ] — 2025-01-15 MISE EN PLACE DU HEADER + Création du header avec logo et titre + Ajout de la navigation principale (liens) ~ Couleurs provisoires, à affiner plus tard [ v0.01.0 ] — 2025-01-18 NOUVELLE FONCTIONNALITÉ : SECTION GALERIE + Ajout de la section galerie de projets + Intégration de 3 cartes de projets avec images * Correction : lien cassé vers Assets/img/logo.png [ v0.01.1 ] — 2025-01-19 CORRECTIFS MOBILE * Correction : galerie non responsive sur mobile * Correction : texte trop petit sur écrans < 480px [ v0.02.0 ] — 2025-01-25 NOUVELLE FONCTIONNALITÉ : FORMULAIRE DE CONTACT + Ajout de la section contact avec formulaire + Ajout du footer avec liens réseaux sociaux [ v1.00.0 ] — 2025-02-01 MISE EN LIGNE OFFICIELLE 🎉 + Publication sur GitHub Pages + Ajout du lien vers le site dans README.md ~ Projet considéré stable et présentable

🔑

Les symboles à utiliser

Utilise toujours les mêmes symboles pour que ton patch-note soit facile à lire d'un coup d'œil :

Symbole	Signification	Exemple
+	Ajout d'une nouvelle chose (feature, fichier, section…)	`+ Ajout de la page contact`
*	Correction d'un bug ou d'une erreur	`* Correction du menu cassé`
~	Modification, amélioration d'une chose existante	`~ Mise à jour des couleurs`
-	Suppression d'une chose	`- Suppression de l'ancienne galerie`

💡Ces symboles ne sont pas une règle universelle officielle — c'est ta convention personnelle. L'important c'est d'être cohérent : une fois que tu as choisi tes symboles, utilise-les toujours pareil dans tout ton fichier.

📁

Où placer le fichier et comment le créer ?

Le patch-note.txt se place à la racine du projet, au même niveau que index.html :

      mon-site/
      ├── 📁 Assets/
      ├── index.html
      ├── patch-note.txt ← ici, à la racine !
      └── README.md
    

Créer le fichier avec VS Code

1

Dans VS Code, fais un clic droit sur la racine de ton projet dans le panneau de gauche

2

Choisis "Nouveau fichier" et tape patch-note.txt

3

Écris ta première entrée : la version initiale v0.00.1 avec la date du jour et "Début du projet"

4

À chaque fois que tu fais un commit Git, tu mets à jour le patch-note avant de pusher !

🌟La bonne habitude : mets à jour le patch-note en même temps que tu fais ton commit Git. Le message de commit et l'entrée de patch-note se complètent : le commit dit "quoi" en bref, le patch-note détaille "quoi, comment et pourquoi".

🔗

Lier commit Git et patch-note

Pour chaque nouvelle version, tu fais deux choses en même temps : tu mets à jour le patch-note ET tu fais un commit Git. Voici le flux idéal :

1

Tu travailles sur ton projet et tu ajoutes une fonctionnalité

2

Tu ouvres patch-note.txt et tu ajoutes la nouvelle entrée de version avec la date et les détails

3

Dans CMD : git add . (inclut le patch-note mis à jour)

4

Dans CMD : git commit -m "v0.01.0 — Ajout galerie de projets"

5

Dans CMD : git push pour envoyer sur GitHub

🚀En nommant ton commit avec le numéro de version (v0.01.0), tu peux retrouver n'importe quelle version dans l'historique Git rien qu'avec git log. Le versioning et Git deviennent une vraie machine à remonter le temps !

✓

Résumé : les règles du patch-note

✅ patch-note.txt à la racine du projet, toujours

✅ Format : [ vX.XX.X ] — AAAA-MM-JJ puis les changements

✅ + ajout | * correction | ~ modification | - suppression

✅ v0 = en développement | v1 = version publique prête

✅ Mise à jour à chaque commit Git — c'est un duo inséparable !

Patch-notes &Versioning

Patch-notes &
Versioning