Cum să scrieți un mesaj Git Commit eficient și util

Mesajele de comitere sunt descrieri scurte ale fiecărei comenzi într-un sistem de control al versiunilor precum Git. Când efectuați modificări ale fișierelor de proiect, ar trebui să furnizați un mesaj care explică ce fac acestea sau de ce le-ați făcut.

Mesajele de angajare servesc ca formă de documentare și comunicare. Ele joacă un rol crucial în menținerea unui istoric al versiunilor clar și organizat al unui proiect. Învață cum să scrii mesaje bune de angajare și ceilalți membri ai echipei tale vor aprecia și mai mult munca ta.

Structura unui mesaj de angajament bun

Un bun exemplu de mesaj de confirmare include patru secțiuni: Tip, Descriere, Corp și Subsol.

Ca astfel:

: 
[corp opțional]
[subsol opțional]

Tip

Tipul descrie tipul de modificare făcută în comiterea actuală. Puteți utiliza orice sistem are sens pentru circumstanțele dvs. De exemplu, iată câteva exemple de cuvinte cheie pe care le puteți folosi pentru a semnala fiecare tip de schimbare, alături de exemplu de utilizare:

• feat: modificările dvs. introduc o nouă caracteristică.
• repara: remediați o eroare.
• refactor: modificați codul dvs. de refactor fără a remedia o eroare sau a adăuga o nouă caracteristică.
• Test: efectuați orice modificări legate de testare. De exemplu, când tu scrie teste cu Jest sau oricare alt cadru de testare tu alegi.
• corvoadă: modificări care nu au legătură cu o remediere, o caracteristică sau un test. De exemplu, actualizarea dependențelor.
• docs: când actualizați documentația.
• stil: modificări care nu afectează semnificația codului, cum ar fi adăugarea de spațiu alb, lipsa punctului și virgulă etc.
• perf: modificări legate de îmbunătățirea performanței.
• construi: când faceți modificări care afectează fișierele de compilare.
• ci: modificări legate de integrarea continuă.
• reveni: la revenirea la o comitere anterioară.

Descriere

„Descrierea” unui mesaj de comit este un rezumat concis și descriptiv al modificărilor făcute în commit. Acesta servește ca titlu care surprinde esența commit-ului.

Când scrieți descrierea, țineți cont de următoarele:

• Faceți-l suficient de clar și specific pentru a descrie comiterea dintr-o privire.
• Fă-l scurt și concis. În mod ideal, limitarea acestuia la 50 de caractere sau mai puțin ar fi cea mai bună.
• Scrieți-l la timpul prezent, chiar dacă descrieți modificările deja făcute.
• Folosiți starea de spirit imperativă în timp ce o scrieți.
• Începeți cu o literă mare.
• Nu termina cu un punct.

De exemplu:

feat: implementați comutarea modului întunecat pentru pagina de pornire

Acest exemplu arată cum puteți scrie descrierea unui commit care implementează modul întunecat. Acesta folosește feat tip deoarece introduce o nouă caracteristică.

Corp (Opțional)

Secțiunea de corp a unui mesaj de comit oferă detalii suplimentare și context despre modificările făcute în commit. Nu veți avea întotdeauna nevoie de un corp, dar vă poate ajuta să furnizați mai multe informații, să explicați raționamentul unei schimbări sau să descrie orice considerații tehnice.

Iată câteva lucruri de reținut când scrieți secțiunea de corp a unui mesaj de confirmare:

• Git nu împachetează niciodată textul în mod automat, așa că împachetați-l manual la 72 de caractere atunci când scrieți corpul. Acest lucru îi oferă lui Git suficient spațiu pentru a indenta text, făcându-l mai lizibil.
• Folosește corpul pentru a explica ce s-a întâmplat în schimbare, de ce ai făcut schimbarea și raționamentul din spatele schimbării tale.
• Trebuie să lăsați o linie goală între linia descrisă și corp. Acest lucru îi permite lui Git să facă distincția între ele.
• Dacă commit-ul introduce mai multe modificări sau afectează diferite zone ale bazei de cod, luați în considerare utilizarea marcatorilor sau a paragrafelor pentru a defalca modificările. Acest lucru îmbunătățește lizibilitatea și ajută cititorii să înțeleagă diferitele aspecte ale comiterii.

De exemplu:

feat: Adăugați GitHub ca furnizor OAuth
Integrați GitHub ca furnizor OAuth pentru a activa fără întreruperi 
autentificarea cu conturile GitHub.
- Implementați fluxul de autentificare OAuth cu API-ul GitHub
- Configurați punctele finale și setările necesare pentru autentificarea GitHub
- Actualizați interfața de utilizator pentru a include opțiunea de conectare GitHub

Exemplul de mai sus arată un mesaj Git commit bun pentru o caracteristică care adaugă GitHub ca furnizor OAuth la cererea dvs. Acest mesaj de confirmare are un rezumat concis (50 de caractere sau mai puțin), un text explicativ mai detaliat (încărcat la aproximativ 72 de caractere) și marcatori pentru informații suplimentare.

Secțiunea de subsol dintr-un mesaj de confirmare este o parte opțională care oferă informații suplimentare sau metadate legate de comitere. De obicei, este plasat după secțiunea corpului, separat printr-o linie goală. Subsolul poate include diverse tipuri de informații, cum ar fi referințe la probleme conexe, etichete sau note speciale.

Când faceți referire la probleme, solicitări de extragere sau alte elemente conexe, utilizați sintaxa sau formatul corespunzătoare cerut de sistemul de urmărire a problemelor din proiect. Acest lucru asigură că referințele sunt recunoscute și legate în mod corespunzător.

De exemplu:

feat: Adăugați GitHub ca furnizor OAuth
Integrați GitHub ca furnizor OAuth pentru a activa fără întreruperi 
autentificarea cu conturile GitHub.
- Implementați fluxul de autentificare OAuth cu API-ul GitHub
- Configurați punctele finale și setările necesare pentru autentificarea GitHub
- Actualizați interfața de utilizator pentru a include opțiunea de conectare GitHub
Rezolvă: #123
Vezi și: #456, #789

Subsolul face referire la problema conexă #123 și menționează alte probleme conexe #456 și #789 pentru context suplimentar.

Adăugarea mesajului Commit

Puteți scrie mesaje de confirmare folosind -m flag urmat de mesajul de commit inclus între ghilimele (opțional, dar recomandat).

The -m flag este ideal pentru mesaje scurte de confirmare, incluzând de obicei tipul și descrierea.

De exemplu:

git commit -m "chore: Schimbați linter în ESlint"

Cu toate acestea, atunci când mesajul dvs. de commit necesită mai multe detalii, cum ar fi un corp și un subsol, ar fi mai bine să scrieți commit-ul într-un editor de text sau IDE.

Alternativ, puteți scrie mesaje lungi de confirmare într-un fișier text și puteți utiliza --fişier flag pentru a specifica mesajele de confirmare ca conținut al fișierului text.

De exemplu:

git commit --file commit_message.txt

Când rulați comanda de mai sus, git va folosi conținutul fișierului ca mesaj de confirmare.

De asemenea, îi puteți spune lui git să deschidă editorul implicit pentru a scrie un mesaj mai lung. Dacă aveți setată variabila de mediu GIT_EDITOR sau EDITOR, git va deschide acel program atunci când rulați un bare git commit comanda.

De ce ar trebui să scrieți mesaje bune de angajare

Scrierea de mesaje bune de commit este crucială pentru o colaborare eficientă și pentru întreținerea codului. Mesajele clare și descriptive ajută la înțelegerea, depanarea și revizuirea codului. Ei pot chiar contribui la documentarea proiectului sau la notele de lansare.

Acestea permit partajarea cunoștințelor, integrarea lină și acceptă controlul versiunilor. Prioritizarea mesajelor de confirmare a calității îmbunătățește procesele de dezvoltare și asigură menținerea bazei de cod.