Żądania pull są jak krew życia w repozytorium. Dzięki temu wszystko jest w dobrym stanie i porusza się. Z tej strony dowiesz się, jak utworzyć kompletny i łatwy do sprawdzenia PR, co zwiększa prawdopodobieństwo, że PR zostanie połączony.
Oto czynności, które możesz wykonać, by uzyskać najlepszą możliwą PR.
poinformuj o zmianie,
Zanim zaczniesz pisać kod, dobrze jest skontaktować się z podstawowym zespołem, aby wiedział, co Cię interesuje.
Jeśli jest jakiś problem, który Cię interesuje, umieść na nim komentarz, w którym, że zaczniesz nad nim pracować. Dzięki temu będziemy mieć pewność, że wiele osób nie pracuje nad tym samym. Ktoś z zespołu potwierdzi, że numer należy do Ciebie.
Jeśli masz pomysł, którego nie obejmuje dany problem, napisz go, zanim rozpoczniesz pracę. Dzięki temu zespół będzie mógł omówić, jak najlepiej wprowadzić daną zmianę, zanim zaczniesz tworzyć treści, co pozwoli Ci zaoszczędzić na pracy na dłuższą metę.
Skonfiguruj
Jeśli po raz pierwszy publikujesz treści w blockly lub blockly-Sample, zacznij na stronie konfiguracji dla programistów.
Niski rozmiar
Zawsze staraj się wprowadzać niewielkie i konkretne zmiany. Zdecydowanie wolelibyśmy sprawdzać kilka mniejszych agencji PR niż jednego gigantycznego PR. Oto kilka rzeczy, o których warto pamiętać:
- Napraw 1 problem. Nie próbuj rozwiązywać wielu problemów naraz.
- Ogranicz zakres. Zwykle PR zajmuje mniej niż 8 godzin (w zależności od Twojej znajomości bazy kodu).
- Używaj zatwierdzeń. Jeśli uważasz, że Twój PR jest za duży, podziel zmiany na logiczne grupy za pomocą zatwierdzeń Git.
Dbaj o czystość
Dlaczego styl kodu jest ważny? Traktujemy je długofalowo, a spójny styl ułatwia utrzymanie. Styl odnosi się do nadawania nazw zmiennym, ale także określa strukturę kodu, pisanie komentarzy itd. Gdy tylko jest to możliwe, używamy narzędzi takich jak eslint, aby automatyzować sprawdzanie stylów.
Oprócz korzystania z eslint przestrzegaj tych wytycznych:
- Przewodnik po stylu Google JavaScript.
- Przewodnik dotyczący zatwierdzenia wiadomości
- Wskazówki dotyczące korzystania z interfejsów API Blockly
- Przewodnik stylistyczny Codelabs
Sprawdź swoje zmiany
Zanim zaczniesz tworzyć stronę PR, zawsze sprawdź, czy zmiany działają, aby nie musieć wracać do poprzednich poprawek. Oto kilka pomysłów na przetestowanie różnych kategorii projektów:
- W przypadku wtyczek: napisz automatyczne testy mokki obejmujące wprowadzone zmiany.
- Na przykłady: ręcznie przetestuj wszystkie zaprezentowane funkcje.
- W przypadku ćwiczeń z programowania przejdź przez cały samouczek w czystym środowisku i przetestuj każdy udostępniony przez Ciebie przykładowy kod.
poinformuj o zmianie,
To ostatni i prawdopodobnie najważniejszy element PR: stworzenie podsumowania.
Napisanie świetnego podsumowania PR pomoże innym deweloperom oceniać zmiany, dzięki czemu jest bardziej prawdopodobne, że zostaną one szybciej zaakceptowane.
Podsumowanie powinno zawierać następujące dane:
- Czego dotyczy Twój PR.
- Zmiany wprowadzone przez Twój PR.
- Sposób testowania zmiany.
- To wszystko, co ma być weryfikowane przez weryfikatorów.
- Wszelkie inne informacje, których Twoim zdaniem potrzebują weryfikatorzy.
Możesz skorzystać z szablonu PR podczas tworzenia żądania. Pamiętaj, aby było ono jak zwięzłe i pełne.
Miłego programowania!