Posted in

Git – Convencions per escriure bons missatges de commit

Convencions per escriure bons missatges de commit

Un bon missatge de commit ajuda a entendre millor l’evolució del projecte i a mantenir el codi net i ben documentat.

Format recomanat

tipus: resum breu en minúscula i imperatiu
Cos opcional amb més detalls del commit si cal, per exemple explicant el perquè del canvi o consideracions addicionals.
Aquesta estructura segueix la convenció coneguda com a Conventional Commits, que ajuda a mantenir un historial comprensible i fàcil de llegir, especialment útil quan es generen changelogs automàtics.

Tipus principals que faig servir

feat: per afegir funcionalitats noves.
fix: per corregir errors.
chore: per tasques de manteniment (com traduccions, neteja, dependències…).

Altres tipus útils

docs: per a canvis en la documentació, README, comentaris…
style: per canvis estètics que no afecten la lògica (indentació, espais, etc.)
refactor: per reorganitzar o millorar el codi sense canviar el comportament
test: per afegir o modificar proves
build: per a canvis relacionats amb el sistema de compilació o dependències
ci: per modificacions en la configuració d’integració contínua
perf: per millores de rendiment

Exemples

Només títol:

feat: afegeix sistema de puntuació per als usuaris

Només títol amb àrea específica:

feat(meta): afegeix suport per metadades a les publicacions

Amb cos explicatiu:

fix: corregeix error en la validació del formulari de registre

El botó de “crear compte” apareixia desactivat quan es deixava el camp telèfon en blanc, tot i ser opcional.
Ara el formulari valida correctament i permet continuar.

Consells ràpids

Escriu el títol en imperatiu, com si donessis una ordre: “afegeix”, “corregeix”…

No siguis genèric: evita “update” o “coses”.

El títol hauria de tenir com a màxim 50 caràcters.

Si afegeixes un cos, separa’l amb una línia en blanc i escriu línies de fins a 72 caràcters màxim.

Si un commit només conté un petit canvi i ja queda clar amb el títol, el cos és opcional.

Deixa un comentari

L'adreça electrònica no es publicarà. Els camps necessaris estan marcats amb *


The reCAPTCHA verification period has expired. Please reload the page.