Komunikaty zatwierdzenia
Jasne komunikaty o zatwierdzeniu ułatwiają sprawdzanie żądań scalenia i generowanie informacji o wersji. Projekt Blockly korzysta z konwencjonalnych commitów, aby ułatwić ten proces.
Każda zmiana powinna mieć format:
<type>: <description>
[optional body]
[optional footer(s)]
Pamiętaj, że w głównym repozytorium Blockly znajduje się narzędzie do sprawdzania poprawności commitów, które pomaga w egzekwowaniu tego wymagania. Jeśli Twoje żądanie scalenia zawiera wiele zatwierdzeń, linter sprawdzi tytuł. Jeśli zawiera tylko 1 zatwierdzenie, sprawdzi to zatwierdzenie. Zalecamy, aby zarówno poszczególne zmiany, jak i tytuł żądania scalenia były zgodne z tymi wytycznymi.
Typ
Typ musi być niepusty i zapisany małymi literami. Poniżej znajdziesz listę akceptowanych typów.
chore: w przypadku commitów, które wykonują rutynowe lub zautomatyzowane zadania, takie jak uaktualnianie zależności.deprecate: w przypadku zatwierdzeń, które wycofują funkcje.feat: w przypadku commitów, które dodają nowe funkcje do Blockly.fix: w przypadku zmian, które naprawiają błędy w Blockly.release: w przypadku zatwierdzeń związanych z wydaniem nowej wersji.
Zmiany powodujące niezgodność
W przypadku commitów, które wprowadzają zmiany powodujące niezgodność wsteczną, po typie commitu należy dodać znak !. Zmiany powodujące niezgodność to zmiany, które mogą spowodować problemy u deweloperów korzystających z Blockly w swoich aplikacjach, co zmusi ich do dodatkowej pracy.
Na przykład:none
fix!: return type of workspace.paste
Zmiany powodujące niezgodność mogą mieć dowolny z wyżej wymienionych prawidłowych 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, powinien być oddzielony od opisu pustym wierszem. Musi być podzielony na wiersze o długości nie większej niż 256 znaków.
Pamiętaj, że zwykle zaleca się umieszczanie tego rodzaju informacji w opisie żądania scalenia, a nie bezpośrednio w zatwierdzeniu.
Stopka
Stopka jest opcjonalna. Jeśli jest podany, powinien być oddzielony od treści pustym wierszem. Musi być podzielony na wiersze o długości nie większej niż 256 znaków.
Poprawianie nietypowych commitów
Jeśli podczas wprowadzania zmian nie używasz konwencjonalnych commitów, masz 2 opcje naprawienia wiadomości w zależności od liczby commitów:
Jeśli Twoje żądanie scalenia zawiera wiele zatwierdzeń, zmień jego tytuł, aby spełniał wymagania. Gdy żądanie scalenia zostanie scalone, pozostałe commity zostaną spłaszczone, a tytuł stanie się komunikatem commita.
Jeśli Twoje żądanie scalenia zawiera tylko 1 zatwierdzenie, zmień wiadomość zatwierdzenia za pomocą polecenia
git commit --amend, a następnie wymuś przesłanie zmian do rozwidlenia Blockly. Spowoduje to automatyczne zaktualizowanie wszystkich otwartych żądań scalenia powiązanych z tym rozgałęzieniem.git push --force origin my-branch.