Matt Dizak
E-mail

Chcesz poprawić swoją reputację w GitHub? Oto jak formatować komunikaty o zatwierdzeniach.

Zamiast pisać jednowierszowe komunikaty git commit z rozszerzeniem commit -m opcja, z tego artykułu dowiesz się, jak pisać poprawne komunikaty o zmianach. Właściwe komunikaty o zmianach są ważne, ponieważ pozwalają innym dokładnie zobaczyć, co zmodyfikowałeś, ułatwianie realizacji projektu innym osobom, pomagając zwiększyć ekspozycję na open source społeczność.

Napisz odpowiednią wiadomość dotyczącą zatwierdzenia

Zamiast dołączać komunikat o zatwierdzeniu do polecenia terminala, otwórz swój ulubiony Edytor tekstu do pustego pliku. Wiadomość powinna mieć następujący format:

nano vs. Vim: Porównanie najlepszych edytorów tekstu terminala

Szukasz edytora tekstu terminala dla systemu Linux? Główny wybór to Vim i nano! Oto jak się porównują.

  • Pierwsza linia to tytuł, podsumowujący całe zatwierdzenie.
  • Po pustej linii, następna linia lub kilka linii powinno zawierać czytelny opis niezbędny do zatwierdzenia. Może to trwać dowolnie długo.
    • instagram viewer
  • Wszystkie poniższe wiersze powinny podsumowywać dokładne zmiany wprowadzone w kodzie w takim formacie:
    • Nazwa pliku: Linia # - Krótki opis modyfikacji.

Przykładowy komunikat dotyczący zatwierdzenia

Poniżej przedstawiono przykładowy komunikat dotyczący zatwierdzenia: 


Dodano obsługę Dockera, nową funkcję is_unique oraz poprawkę błędów.
Dodano obsługę docker-compose i zaktualizowano instrukcje instalacji w razie potrzeby. Zawiera również nową funkcję w ramach funkcji check_order () do sprawdzania unikalności i naprawiono mały błąd podczas tworzenia informacji o produkcie.
src / somedir / library.py: 381 - Dodano parametr 'is_unique' do funkcji check_order ().
src / products.py: 194 - Naprawiono błąd podczas tworzenia informacji o produkcie.
docker-compose.yml - Dodano plik docker-compose.
docs / install.md - zaktualizowany przewodnik instalacji, aby uwzględnić sposób instalacji przez Docker.

Commit Message

Podczas wykonywania zatwierdzenia teraz, zamiast używania -m wiadomość, użyj--plik opcja. Na przykład, jeśli nazwa pliku twojego komunikatu o zmianach to commit.txt, uruchomisz polecenie: 

git commit --file commit.txt

To wszystko! Miejmy nadzieję, że pomoże to w dostarczaniu bardziej ustandaryzowanych i jasnych komunikatów dotyczących zatwierdzania dla obserwujących, pomagając Twojemu projektowi zyskać rozgłos i pomóc otwarte źródło społeczność rośnie.

Źródło zdjęcia: Caleb White /Unsplash

E-mail
Jak stworzyć swoje pierwsze repozytorium na Github

Chcesz udostępniać swoje projekty programistyczne online? Oto, jak rozpocząć korzystanie z pierwszego repozytorium Github.

Powiązane tematy
  • Programowanie
  • GitHub
O autorze
Matt Dizak (13 opublikowanych artykułów)Więcej od Matta Dizaka

Zapisz się do naszego newslettera

Dołącz do naszego biuletynu, aby otrzymywać wskazówki techniczne, recenzje, bezpłatne e-booki i ekskluzywne oferty!

Jeszcze jeden krok…!

Potwierdź swój adres e-mail w wiadomości, którą właśnie wysłaliśmy.

.