Autor: Matt Dizak
Email

Chcete si vylepšiť reputáciu na GitHub? Tu je príklad, ako formátovať správy o potvrdení.

Namiesto písania jednoriadkových správ git commit pomocou spáchať -m V tomto článku sa dozviete, ako písať správne správy o odovzdaní. Správne správy o odovzdaní sú dôležité, pretože umožňujú ostatným vidieť presne to, čo ste zmenili, uľahčenie sledovania vášho projektu ostatným pomáha zvýšiť vašu expozíciu voči otvorenému zdroju komunita.

Napíš riadnu správu o potvrdení

Namiesto zahrnutia správy o potvrdení do príkazu terminálu otvorte svoju obľúbenú textový editor do prázdneho súboru. Správa by mala zodpovedať nasledujúcemu formátu:

nano vs. Vim: Najlepšie porovnávané textové editory terminálu

Hľadáte textový editor terminálu pre Linux? Hlavná voľba je medzi Vim a nano! Tu je ich porovnanie.

  • Prvý riadok je názov, ktorý sumarizuje celé potvrdenie.
  • Za prázdnym riadkom by mal byť nasledujúci alebo niekoľko riadkov akýkoľvek čitateľný popis potrebný na potvrdenie. Môže to byť tak dlho, ako je potrebné.
    • instagram viewer
  • Všetky nasledujúce riadky by mali sumarizovať presné zmeny vykonané v kóde v takom formáte:
    • Názov súboru: Riadok # - stručný popis úpravy.

Príklad správy o potvrdení

Nižšie je uvedená príklad správy o potvrdení: 


Pridaná podpora Dockeru, nová funkcia is_unique a oprava chyby.
Pridaná podpora pre docker-compose a podľa potreby aktualizované inštalačné pokyny. Zahrnutá tiež nová funkcia vo funkcii check_order () na kontrolu jedinečnosti a opravená malá chyba pri vytváraní produktových slimákov.
src / somedir / library.py: 381 - Pridaný parameter 'is_unique' do funkcie check_order ().
src / products.py: 194 - Opravená chyba pri vytváraní produktu slimák.
docker-compose.yml - Pridaný súbor docker-compose.
docs / install.md - Aktualizovaný inštalačný sprievodca, ktorý obsahuje informácie o inštalácii pomocou Dockeru.

Potvrdiť správu

Keď sa teraz rozhodujete, namiesto -m správu, použite--súbor možnosť. Napríklad ak je názov vašej správy o potvrdení commit.txt, spustili by ste príkaz: 

git commit --file commit.txt

To je všetko! Dúfajme, že to pomôže poskytnúť štandardizovanejšie a jasnejšie správy o odovzdaní vašim sledovateľom, pomôže to vášmu projektu získať viac pozornosti a pomôžete otvorený zdroj komunita rastie.

Obrázok: Caleb White /Unsplash

Email
Ako vytvoriť prvé úložisko na Github

Chcete zdieľať svoje vývojové projekty online? Tu je postup, ako začať s prvým úložiskom Github.

Súvisiace témy
  • Programovanie
  • GitHub
O autorovi
Matt Dizak (13 publikovaných článkov)Viac od Matta Dizaka

Prihlásiť sa ku odberu noviniek

Pripojte sa k nášmu bulletinu s technickými tipmi, recenziami, bezplatnými elektronickými knihami a exkluzívnymi ponukami!

Ešte jeden krok…!

V e-maile, ktorý sme vám práve poslali, potvrďte svoju e-mailovú adresu.

.