Gole
Proces sprawdzania ma kilka celów:
- Zadbaj o wysoką jakość kodu, zarówno pod względem funkcjonalności, jak i czytelności.
- Wyłapywać błędy, bo błędy się zdarzają.
- Zachowaj spójny styl, by łatwo rozpocząć pracę w dowolnej części bazy kodu.
Cały kod, który wchodzi w skład próbek blokowych i core Blockly, przechodzi proces sprawdzania. Nie ma znaczenia, czy został on napisany przez współtwórców społeczności czy członków zespołu Blockly.
Jako weryfikatorzy będziemy współpracować z Tobą, aby wprowadzić jak najlepsze zmiany. Prosimy Was, jako współtwórców, o rozmowę z nami w celu rozpatrzenia i połączenia przesyłanych próśb.
Procedura
Proces weryfikacji PR obejmuje kilka etapów:
Projekt
Gdy otrzymasz taką prośbę, dyżurny członek zespołu Blockly przypisze weryfikatora.
Weryfikatorzy są wybierani na podstawie ich wiedzy specjalistycznej i rozdzielają obciążenia równomiernie.
Przypisanie recenzenta może zająć kilka dni, a rozpatrzenie wniosku – jeszcze kilka dni. Nie martw się, to normalne.
Prześlij opinię
Na etapie przekazywania opinii weryfikator podaje sugestie zmian w Twoim PR. Może to być proste czynności, które sprawią, że kod będzie zgodny ze wskazówkami dotyczącymi stylu JavaScript Google. Mogą też być szersze, np. prośba o reorganizację definicji funkcji.
Zachęcamy weryfikatorów do sprawdzania kodu w usłudze GitHub (zamiast do dodawania pojedynczych komentarzy), ponieważ dzięki temu otrzymasz jedno powiadomienie, a nie kilka.
Dyskusja
W fazie dyskusji masz okazję, aby odpowiedzieć na swoje uwagi. Być może jeden z komentarzy nie był jasny: teraz masz szansę poprosić o wyjaśnienie. Być może weryfikator poprosił o zmianę, ale Twoim zdaniem będzie to miało konsekwencje: teraz masz szansę znaleźć kompromis.
Wersja
Etap weryfikacji to etap, na którym możesz wprowadzić zmiany w swoim PR. Zwykle te zmiany są wynikiem opinii weryfikatora na etapie opinii.
Po zakończeniu poprawek warto oznaczyć tagiem osobę sprawdzającą, aby zrobiła to ponownie.
Powtórzenia
Po zakończeniu etapu weryfikacji weryfikator będzie miał jeszcze jedną szansę na przekazanie opinii. Proces weryfikacji zaczyna się od początku.
Często druga weryfikacja jest prosta i obejmuje nitki takie jak interpunkcja i styl kodu. Czasem jednak druga opinia może być dość duża. Pierwszy recenzent może nawet poprosić kogoś innego o dopilnowanie, aby spojrzeli na stronę z nowej perspektywy.
Scal!
Etap scalania to Twoja szansa na ulepszenie. Udało Ci się utworzyć zmianę, omówić ją i poprawić, a w końcu połączyć! To wielkie osiągnięcie, które wiele osób nigdy nie zaczęło, a co już robić.
Dziękujemy za Twoją ciężką pracę nad ulepszaniem Blockly. Gratulacje!