Øk omdømmet til Github med riktige forpliktelsesmeldinger

I stedet for å skrive en-linjers git begå meldinger med begå -m alternativ, i denne artikkelen lær hvordan du skriver riktige kommisjonsmeldinger. Det er viktig med riktige kommitteringsmeldinger, ettersom det lar andre se nøyaktig hva du har endret, gjør prosjektet ditt lettere for andre å følge og bidrar til å øke eksponeringen din for åpen kildekode samfunnet.

Skriv en ordentlig forpliktende melding

I stedet for å inkludere kommittemeldingen i terminalkommandoen, åpne din favoritt tekstredigerer til en tom fil. Meldingen skal ha følgende format:

• Første linje er tittelen, som oppsummerer hele forpliktelsen.
• Etter en tom linje bør neste linje eller flere linjer være en lesbar beskrivelse som er nødvendig for forpliktelsen. Dette kan være så lenge som ønsket.
instagram viewer
• Alle følgende linjer skal oppsummere de eksakte endringene som er gjort i koden i et slikt format:
  • Filnavn: Linje # - Kort beskrivelse av modifikasjon.

Eksempel på forpliktelsesmelding

Nedenfor vises et eksempel på en meldingsmelding:

Lagt til Docker-støtte, ny is_unique-funksjon, pluss feilretting.
Lagt til støtte for docker-compose og oppdatert installasjonsinstruksjon etter behov. Inkluderte også en ny funksjon innen check_order () -funksjonen for å se etter unikhet, og fikset liten feil når du oppretter produktsnegler.
src / somedir / library.py: 381 - Lagt til parameteren 'is_unique' til funksjonen check_order ().
src / products.py: 194 - Rettet feil når du lager produktsnegl.
docker-compose.yml - Lagt til docker-compose-fil.
docs / install.md - Oppdatert installasjonsveiledning for å inkludere hvordan du installerer via Docker.

Forplikt melding

Når du forplikter deg nå, i stedet for å bruke -m melding, bruk--fil alternativ. For eksempel, hvis filnavnet til kommisjonsmeldingen er commit.txt, vil du kjøre kommandoen:

git commit --file commit.txt

Det er alt det er! Forhåpentligvis hjelper dette deg med å gi mer standardiserte og klare forpliktende meldinger til dine følgere, og hjelper prosjektet å få eksponering, og hjelpe åpen kilde samfunnet vokser.

Bildekreditt: Caleb White /Uplask