Sporiți-vă reputația Github cu mesaje de angajament adecvate

În loc să scrieți o linie git commit messages cu comite -m opțiune, în acest articol aflați cum să scrieți mesaje de confirmare adecvate. Un mesaj corect de confirmare este important, deoarece permite celorlalți să vadă exact ceea ce ați modificat, facilitând urmărirea proiectului de către alții, contribuind la creșterea expunerii dvs. la sursa deschisă comunitate.

Scrieți un mesaj de comitere adecvat

În loc să includeți mesajul de confirmare în comanda terminalului, deschideți-vă preferatul editor de text la un fișier gol. Mesajul trebuie să respecte următorul format:

• Prima linie este titlul, rezumând întregul commit.
• Urmând o linie goală, următoarea linie sau mai multe linii ar trebui să fie orice descriere lizibilă necesară pentru commit. Acest lucru poate fi atâta timp cât se dorește.
  instagram viewer
• Toate rândurile următoare ar trebui să rezume modificările exacte aduse codului într-un astfel de format:
  • Numele fișierului: Linia # - Scurtă descriere a modificării.

Exemplu Mesaj de comitere

Mai jos este prezentat un exemplu de mesaj de validare:

S-a adăugat suport Docker, noua funcție is_unique, plus remedierea erorilor.
S-a adăugat suport pentru compunerea docher și instrucțiuni de instalare actualizate, după caz. De asemenea, a fost inclusă o nouă caracteristică în cadrul funcției check_order () pentru a verifica caracterul unic, și s-a remediat o mică eroare la crearea limuzelor de produs.
src / somedir / library.py: 381 - A fost adăugat parametrul „is_unique” la funcția check_order ().
src / products.py: 194 - S-a remediat eroarea la crearea slugului produsului.
docker-compose.yml - A fost adăugat fișierul docker-compose.
docs / install.md - Ghid de instalare actualizat pentru a include modul de instalare prin Docker.

Mesaj de comitere

Când faceți un commit acum, în loc să utilizați -m mesaj, utilizați--fişier opțiune. De exemplu, dacă numele fișierului mesajului dvs. de confirmare este commit.txt, ați rula comanda:

git commit --file commit.txt

Cam despre asta e! Sperăm că acest lucru vă ajută să furnizați mesaje de comitere mai standardizate și mai clare către adepții dvs., ajutând proiectul să câștige expunere și să ajute sursa deschisa comunitatea crește.

Credit de imagine: Caleb White /Unsplash