Przewodnik po zatwierdzeniach

Zatwierdź wiadomości

Przejrzyste komunikaty zatwierdzenia ułatwiają przeglądanie żądań pull i generowanie informacji o wersji. Pomaga w tym projekt Blockly, korzystając z konwencjonalnych zatwierdzeń.

Każde zatwierdzenie powinno mieć format:

<type>: <description>

[optional body]

[optional footer(s)]

Pamiętaj, że podstawowe repozytorium Blockly ma linter zatwierdzenia, który pomaga to wyegzekwować. Jeśli żądanie pull ma wiele zatwierdzeń, linter sprawdzi tytuł. Jeśli ma 1 zatwierdzenie, sprawdzi je. Najlepiej, jeśli zarówno własne zobowiązania, jak i tytuł żądania pull, są zgodne z tymi wytycznymi.

Typ

Pole typu nie może być puste i mogą zawierać wyłącznie małe litery. Poniżej znajduje się lista akceptowanych typów.

praca
Dotyczy zatwierdzenia, które wykonują rutynowe lub automatyczne zadania, takie jak uaktualnianie zależności.
wycofaj
Zatwierdzenia, które wycofują funkcje.
feat
Zgody, które dodają nowe funkcje do Blockly.
fix
Zatwierdzenia, które naprawiają błędy w Blockly.
udzielenie praw
Zgody związane z opublikowaniem nowej wersji.

Niezbędne zmiany

Zatwierdzenia, które wprowadzają zmiany powodujące niezgodność, powinny po typie zatwierdzenia dołączyć !. Niezbędne zmiany to zmiany, które mogą uniemożliwić deweloperom korzystanie z Blockly w aplikacjach, przez co będą musieli wykonać dodatkową pracę.

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

Zmiany powodujące niezgodność mogą mieć dowolny z powyższych prawidłowych typów.

Opis

Opis nie może być pusty i nie może mieć więcej 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 nie dłuższe niż 256 znaków.

Zazwyczaj zalecamy umieszczenie tego rodzaju informacji w opisie żądania, a nie bezpośrednio w zatwierdzeniu.

Stopka jest opcjonalna. Jeśli jest podany, między treścią a treścią powinien być pusty wiersz. Musi być podzielony na wiersze nie dłuższe niż 256 znaków.

Naprawianie niekonwencjonalnych zatwierdzeń

Jeśli podczas wprowadzania zmian nie używano standardowych zatwierdzeń, wiadomości możesz naprawić na 2 sposoby w zależności od liczby zatwierdzeń:

  1. Jeśli żądanie pull ma wiele zatwierdzeń, zmień tytuł żądania pull tak, aby był zgodny z wymaganiami. Po scaleniu żądania pull inne zatwierdzenia są ściśnięte, tak aby tytuł staje się komunikatem zatwierdzenia.

  2. Jeśli żądanie pull zawiera 1 zatwierdzenie, popraw komunikat zatwierdzenia za pomocą git commit --amend, a następnie wymuś wypchnięcie zmian do rozwidlenia Blockly. Spowoduje to automatyczne zaktualizowanie wszystkich otwartych żądań pull powiązanych z tą gałęzią. git push --force origin my-branch.