Przewodnik dotyczący komunikatu zatwierdzenia

Komunikaty zatwierdzenia

Jasne komunikaty o zatwierdzenie ułatwiają sprawdzanie żądań pull request, a notatki o wersji ułatwiają ich generowanie. Projekt Blockly używa tradycyjnych commitów, aby ułatwić to zadanie.

Każdy commit powinien mieć format:

<type>: <description>

[optional body]

[optional footer(s)]

Pamiętaj, że repozytorium główne Blockly zawiera linter do sprawdzania poprawności commitów, który pomaga w egzekwowaniu tej zasady. Jeśli Twoja prośba o przechwycenie zawiera wiele zatwierdzeń, linter sprawdzi tytuł. Jeśli dla pojedynczego zatwierdzenia. Najlepiej, jeśli zarówno poszczególne commity, jak i tytuł żądania pull będą zgodne z tymi wytycznymi.

Typ

Typ nie może być pusty i musi być zapisany małymi literami. Poniżej znajdziesz listę akceptowanych typów.

obowiązki
W przypadku commitów, które wykonują rutynowe lub zautomatyzowane zadania, takie jak uaktualnianie zależności.
wycofaj
W przypadku commitów, które wycofują funkcjonalność.
feat
W przypadku commitów, które dodają nowe funkcje do Blockly.
Napraw
Dla commitów, które naprawiają błędy w Blockly.
udzielenie praw
Dotyczy zatwierdzeń związanych z wydaniem nowej wersji.

Zmiany powodujące niezgodność

Zatwierdzenia, które wprowadzają zmiany powodujące niezgodność, powinny dołączać ! po typie zatwierdzenia. Zmiany powodujące niezgodność to zmiany, które mogą zakłócić działanie deweloperów korzystających z Blockly w ich aplikacje, co wymaga od nich dodatkowej pracy.

Na przykład:fix!: return type of workspace.paste

Zmiany powodujące przerwanie mogą mieć dowolny z wymienionych powyżej typów.

Opis

Opis nie może być pusty i musi mieć mniej niż 256 znaków.

Treść

Treść jest opcjonalna. Jeśli jest podany, między nim a opisem powinien znajdować się pusty wiersz. Musi być podzielony na wiersze po maksymalnie 256 znaków znaków.

Zazwyczaj zalecamy podanie tego typu informacji na stronie opisu żądania pull, a nie bezpośrednio w zatwierdzeniu.

Stopka jest opcjonalna. Jeśli jest podany, między i ciała. Musi być podzielony na wiersze zawierające nie więcej niż 256 znaków.

Naprawianie zatwierdzeń niekonwencjonalnych

Jeśli w konfiguracji modyfikacji, istnieją 2 opcje naprawiania komunikatów w zależności od tego, jak masz wiele zatwierdzeń:

  1. Jeśli żądanie pull ma wiele zatwierdzeń, zmień jego tytuł na spełniają wymagania. Gdy prośba o przeniesienie zostanie scalona, Twoje pozostałe zatwierdzenia zostaną skumulowane, tak aby tytuł stał się komunikatem zatwierdzenia.

  2. Jeśli prośba o przeniesienie zawiera tylko 1 zapis, zmodyfikuj komunikat o zapisie za pomocą git commit --amend, a następnie wymuś wypchnięcie zmian do swojej gałęzi Blockly. Spowoduje to automatyczne zaktualizowanie wszystkich otwartych żądań pull powiązanych z tą gałęzi. git push --force origin my-branch.