Forøg din Github-omdømme med ordentlige forpligtelsesmeddelelser

I stedet for at skrive en-line git begå meddelelser med begå -m valgmulighed, i denne artikel lær hvordan man skriver ordentlige meddelelser. En ordentlig begå besked er vigtig, da det giver andre mulighed for at se nøjagtigt, hvad du har ændret, gør dit projekt lettere for andre at følge, hvilket hjælper med at øge din eksponering for open source fællesskab.

Skriv en ordentlig forpligtelsesmeddelelse

I stedet for at inkludere kommitteringsmeddelelsen i terminalkommandoen skal du åbne din favorit teksteditor til en tom fil. Meddelelsen skal svare til følgende format:

• Første linje er titlen, der opsummerer hele forpligtelsen.
• Efter en tom linje skal den næste linje eller flere linjer være enhver læsbar beskrivelse, der er nødvendig for forpligtelsen. Dette kan være så længe som ønsket.
  instagram viewer
• Alle følgende linjer skal opsummere de nøjagtige ændringer, der er foretaget i koden i et sådant format:
  • Filnavn: Linje # - Kort beskrivelse af ændring.

Eksempel på meddelelse om forpligtelse

Nedenfor vises et eksempel på en meddelelsesmeddelelse:

Tilføjet Docker-support, ny is_unique-funktion plus bug fix.
Tilføjet support til docker-compose og opdateret installationsinstruktion efter behov. Inkluderede også en ny funktion inden for check_order () -funktionen for at kontrollere, om den er unik, og fikset en lille fejl, når du opretter produktslugs.
src / somedir / library.py: 381 - Tilføjet parameteren 'is_unique' til funktionen check_order ().
src / products.py: 194 - Rettet fejl ved oprettelse af produktslug.
docker-compose.yml - Tilføjet docker-compose-fil.
docs / install.md - Opdateret installationsvejledning til at inkludere, hvordan du installerer via Docker.

Forpligt meddelelse

Når du laver en forpligtelse nu, i stedet for at bruge -m besked, brug--fil mulighed. For eksempel, hvis filnavnet på din forpligtelsesmeddelelse er commit.txt, kører du kommandoen:

git commit - fil commit.txt

Det er alt der er til det! Forhåbentlig hjælper dette dig med at levere mere standardiserede og klare forpligtelsesmeddelelser til dine tilhængere, hjælpe dit projekt med at få eksponering og hjælpe åben kilde samfund vokser.

Billedkredit: Caleb White /Uplash