Öka ditt Github-rykte med riktiga meddelanden

Istället för att skriva en rad git begå meddelanden med begå -m alternativ, i den här artikeln lär du dig att skriva riktiga kommunicera meddelanden. Ett riktigt meddelande är viktigt eftersom det låter andra se exakt vad du har ändrat, gör ditt projekt lättare för andra att följa och hjälper dig att öka din exponering för öppen källkod gemenskap.

Skriv ett ordentligt engagemangsmeddelande

Istället för att inkludera kommunicera meddelandet i terminalkommandot, öppna din favorit textredigerare till en tom fil. Meddelandet ska ha följande format:

• Första raden är titeln, som sammanfattar hela engagemanget.
• Efter en tom rad bör nästa rad eller flera rader vara någon läsbar beskrivning som är nödvändig för åtagandet. Detta kan vara så länge som önskat.
instagram viewer
• Alla följande rader ska sammanfatta de exakta ändringarna i koden i ett sådant format:
  • Filnamn: Rad # - Kort beskrivning av modifieringen.

Exempel på meddelande om åtagande

Nedan visas ett exempel på meddelande:

Tillagt Docker-stöd, ny is_unique-funktion, plus bug fix.
Lagt till stöd för docker-compose och uppdaterad installationsinstruktion efter behov. Inkluderade också en ny funktion inom check_order () -funktionen för att söka efter unikhet och fixade ett litet fel när du skapar produktsniglar.
src / somedir / library.py: 381 - Parametern 'is_unique' har lagts till i funktionen check_order ().
src / products.py: 194 - Fixat fel när du skapar produktsnigel.
docker-compose.yml - Tillagd docker-compose-fil.
docs / install.md - Uppdaterad installationsguide för att inkludera hur man installerar via Docker.

Begå meddelande

När du gör ett åtagande nu, istället för att använda -m använda meddelandet--fil alternativ. Till exempel, om filnamnet på ditt engagemangsmeddelande är commit.txt skulle du köra kommandot:

git commit --file commit.txt

Det är allt som finns! Förhoppningsvis hjälper detta dig att tillhandahålla mer standardiserade och tydliga meddelanden till dina följare, vilket hjälper ditt projekt att få exponering och hjälpa öppen källa samhället växer.

Bildkredit: Caleb White /Unsplash