Els missatges de commit són una part essencial del treball amb Git. Escriure bons missatges de commit ajuda a mantenir un historial clar i comprensible, facilitant la col·laboració i la depuració. En aquesta secció, aprendrem les millors pràctiques per escriure missatges de commit efectius.

Importància dels Bons Missatges de Commit

  • Claredat: Proporcionen una descripció clara del que s'ha canviat i per què.
  • Historial Comprensible: Faciliten la navegació i comprensió de l'historial del projecte.
  • Col·laboració: Ajuden els altres membres de l'equip a entendre els canvis.
  • Depuració: Faciliten la identificació de canvis específics quan es resolen problemes.

Estructura d'un Bon Missatge de Commit

Un bon missatge de commit generalment segueix una estructura específica:

  1. Línia de Resum: Una breu descripció del canvi (màxim 50 caràcters).
  2. Línia en Blanc: Separa la línia de resum del cos del missatge.
  3. Cos del Missatge: Descripció detallada del canvi (màxim 72 caràcters per línia).

Exemple d'un Bon Missatge de Commit

Corregit error en la funció de càlcul de descomptes

El càlcul de descomptes no considerava els cupons de descompte
acumulatius. Aquesta correcció assegura que els cupons es
comptabilitzin correctament, evitant descomptes incorrectes.

S'ha afegit una prova unitaria per verificar aquest comportament.

Millors Pràctiques per Escriure Missatges de Commit

  1. Utilitza el Mode Imperatiu

  • Correcte: "Afegeix funció de validació"
  • Incorrecte: "Afegida funció de validació"

  1. Sigues Breu però Descriptiu

  • Correcte: "Corregit error en la funció de càlcul de descomptes"
  • Incorrecte: "Corregit error"

  1. Explica el Perquè, no només el Què

  • Correcte: "Corregit error en la funció de càlcul de descomptes per considerar cupons acumulatius"
  • Incorrecte: "Corregit error en la funció de càlcul de descomptes"

  1. Utilitza Punts de Bala per Llistes

Si el commit inclou múltiples canvis, utilitza punts de bala per clarificar:

Actualitzat el fitxer README

- Afegida secció sobre instal·lació
- Corregits errors tipogràfics
- Actualitzada la informació de contacte

  1. Referencia Problemes o Tiquets

Si el commit resol un problema específic o tiquet, referencia'l:

Corregit error en la funció de càlcul de descomptes

Aquest commit resol el problema #42.

Exercicis Pràctics

Exercici 1: Escriu un Missatge de Commit

Imagina que has corregit un error en la funció de registre d'usuaris que causava que els correus electrònics no es validessin correctament. Escriu un missatge de commit seguint les millors pràctiques.

Solució:

Corregit error en la validació de correus electrònics

La funció de registre d'usuaris no validava correctament els
correus electrònics, permetent adreces no vàlides. Aquesta
correcció assegura que només es permetin correus electrònics
vàlids.

S'ha afegit una prova unitaria per verificar aquest comportament.

Exercici 2: Millora un Missatge de Commit

Millora el següent missatge de commit per fer-lo més clar i descriptiu:

Corregit error

Solució:

Corregit error en la funció de càlcul de descomptes

El càlcul de descomptes no considerava els cupons de descompte
acumulatius. Aquesta correcció assegura que els cupons es
comptabilitzin correctament, evitant descomptes incorrectes.

S'ha afegit una prova unitaria per verificar aquest comportament.

Resum

Escriure bons missatges de commit és essencial per mantenir un historial de projectes clar i comprensible. Seguint les millors pràctiques, com utilitzar el mode imperatiu, ser breu però descriptiu, i explicar el perquè dels canvis, pots assegurar-te que els teus commits siguin útils per a tu i per als teus col·laboradors. Practica aquestes tècniques per millorar la qualitat dels teus missatges de commit i, en conseqüència, la qualitat del teu projecte.

Dominar Git: De Principiant a Avançat

Mòdul 1: Introducció a Git

Mòdul 2: Operacions Bàsiques de Git

Mòdul 3: Branques i Fusió

Mòdul 4: Treballant amb Repositoris Remots

Mòdul 5: Operacions Avançades de Git

Mòdul 6: Eines i Tècniques de Git

Mòdul 7: Estratègies de Col·laboració i Flux de Treball

Mòdul 8: Millors Pràctiques i Consells de Git

Mòdul 9: Resolució de Problemes i Depuració

Mòdul 10: Git en el Món Real

© Copyright 2024. Tots els drets reservats