Otrzymanie recenzji pull requestu

Twoje zgłoszenie pull zostało przesłane i przeszło testy CI. Teraz jest gotowe do przeglądu.

tl;dr – Proces recenzowania

Krótka wersja procesu recenzowania:

1. Poczekaj na recenzję.
2. Odpowiadaj na opinie.
3. Jeśli wymagane są zmiany:
4. Wykonaj żądane zmiany.
5. Prześlij wszystkie wymagane zmiany.
6. Poproś ponownie o weryfikację, gdy wszystkie wymagane zmiany zostaną wprowadzone.
7. Powtarzaj sekcję trzecią, aż nie będą potrzebne żadne dalsze zmiany.
8. Poczekaj, aż Twoja prośba o pull zostanie zatwierdzona i scalona.

Gratulacje! Właśnie wsparłeś BeeWare!

Wysłałem pull request, co dalej?

Po przesłaniu pull requestu należy poczekać na weryfikację swojego wkładu. Proces weryfikacji ma dwie strony: przeprowadzanie weryfikacji i otrzymywanie weryfikacji.

Ocena oczekiwań

Należy oczekiwać, że wszystkie osoby oceniające zgłoszenia będą postępować zgodnie z niniejszymi wytycznymi, w tym członkowie głównego zespołu. Należy również przestrzegać niniejszych wytycznych podczas oceny zgłoszeń innych osób.

Jeśli uważasz, że recenzent nie spełnia tych oczekiwań i czujesz się komfortowo, zgłaszając tę kwestię samodzielnie w pull request, możesz to zrobić. Jeśli nie czujesz się komfortowo, skontaktuj się z zespołem ds. reagowania na naruszenia kodeksu postępowania BeeWare. Przeanalizujemy Twoje zgłoszenie i skontaktujemy się z recenzentem. Działania podjęte w wyniku zgłoszenia będą odzwierciedlały zgłoszone naruszenie; niewielkie wykroczenie może skutkować rozmową, natomiast poważniejsze naruszenie może skutkować bardziej surowymi konsekwencjami.

Przekazanie recenzji

Każdy może zgłaszać uwagi do każdego pull requestu. Te wytyczne opisują nasze oczekiwania dotyczące recenzji, niezależnie od tego, czy są one zgłaszane przez członka zespołu głównego, czy członka społeczności.

Ostateczną weryfikację zawsze musi przeprowadzić członek zespołu podstawowego, ale opinie członków społeczności mogą być pomocne w usprawnieniu tego procesu — w idealnym przypadku weryfikacja przez zespół podstawowy byłaby formalnością po zidentyfikowaniu wszystkich głównych problemów przez społeczność.

Otrzymanie recenzji

Otrzymanie recenzji obejmuje trzy podstawowe kroki:

1. Wstępne opinie i pytania.
2. Zgłoszenia zmian.
3. Zatwierdzenie i scalanie.

Każdy krok został szczegółowo opisany poniżej. Jeśli w trakcie procesu pojawią się jakiekolwiek pytania, nie wahaj się ich zadać! Chętnie służymy pomocą.

Harmonogram i wstępne opinie

Główny zespół dąży do tego, aby każda prośba o pull request została rozpatrzona w ciągu dziesięciu dni roboczych. Jednak w przypadku bardziej skomplikowanych zgłoszeń lub gdy prośba o pull request została złożona w czasie, gdy część zespołu jest na urlopie, termin ten może ulec wydłużeniu.

Zazwyczaj zapewniamy ciągłość współpracy z recenzentami w przypadku każdego pull requestu — oznacza to, że prawdopodobnie będziesz współpracować z tym samym recenzentem przez cały proces recenzji. Dzięki temu recenzent będzie miał pełny kontekst przez cały proces, a Ty będziesz wiedzieć, czego możesz się spodziewać pod względem częstotliwości odpowiedzi i stylu recenzji. Jeśli początkowy recenzent stwierdzi, że nie posiada niezbędnej wiedzy specjalistycznej do recenzowania Twoich pull requestów lub wie, że z jakiegoś powodu nie będzie dostępny, może przekazać odpowiedzialność za Twój pull request innemu członkowi zespołu.

Możesz oczekiwać, że odpowiemy na każdą wiadomość w ciągu dziesięciu dni roboczych. Odpowiadanie na opinie i pytania jest istotną częścią procesu weryfikacji. Przed przejściem do kolejnego etapu procesu oczekujemy odpowiedzi od Ciebie.

Zgłoszenia zmian

W większości przypadków recenzent poprosi Cię o wprowadzenie zmian w Twoim zgłoszeniu pull request. Nie musi to być odzwierciedleniem jakości Twojej pracy, jest to po prostu część procesu.

Jeśli wstępna ocena ujawni znaczną liczbę problemów, pierwsza ocena może nie być kompleksowa. Zamiast tego skoncentruje się ona na zapewnieniu ogólnych wskazówek dotyczących prac niezbędnych do doprowadzenia pull requestu do stanu umożliwiającego scalenie. Proces oceny może obejmować pytania mające na celu wyjaśnienie celu i zakresu podjętych prac.

Wprowadź wymagane zmiany

Osoba recenzująca opublikuje komentarze do Twojego pull requestu. Komentarze te mogą mieć charakter ogólny, dotyczyć konkretnego pliku lub konkretnej linii lub linii kodu. Czasami będą one zawierać bezpośrednie sugestie zmian, które możesz zastosować w swoim pull requestu za pośrednictwem interfejsu użytkownika GitHub. Zazwyczaj będą to pytania, prośby o wyjaśnienia lub wskazówki dotyczące aktualizacji.

Oznaczanie rozmowy jako rozwiązanej

Podczas dyskusji w ramach procesu przekazywania informacji zwrotnych nie należy nigdy oznaczać rozmowy rozpoczętej przez recenzenta jako „rozwiązanej”. Oznaczenie rozmowy jako rozwiązanej należy do obowiązków recenzenta. To on decyduje, czy zidentyfikowany problem został rozwiązany.

Jeśli przegląd ujawni systematyczny problem (np. niespójność nazewnictwa w kodzie), recenzent może nie zaznaczyć każdego wystąpienia tego problemu. Zamiast tego może wybrać kilka przykładów problemu i wskazać, że inne przypadki również powinny zostać poprawione. Jeśli przegląd ujawni problem w jednym miejscu, a uważasz, że może on dotyczyć również innych miejsc, należy naprawić ten problem wszędzie tam, gdzie występuje. Jeśli nie masz pewności, poproś recenzenta o wyjaśnienie.

Prześlij wszystkie wymagane zmiany

Po wprowadzeniu wszystkich wymaganych zmian możesz przesłać aktualizację do swojego pull requestu. Spowoduje to uruchomienie nowego procesu CI. Po potwierdzeniu, że CI nadal przebiega pomyślnie, opublikuj komentarz z prośbą o aktualizację recenzji, a zespół główny ponownie przyjrzy się Twojemu pull requestowi.

Pchnij, nie naciskaj ani nie zmieniaj podstawy

Podczas aktualizacji pull requestu w trakcie przeglądu ważne jest, aby pozostawić historię commitów w stanie nienaruszonym. Nie ma znaczenia, czy lista commitów jest długa — wszystkie zostaną skompresowane podczas scalania pull requestu. Jeśli w trakcie przeglądu wymusisz push lub rebase pull requestu, możesz usunąć ważne informacje potrzebne recenzentowi.

Ponowne zgłoszenie prośby o przegląd

Po wprowadzeniu wszystkich wymaganych zmian w danej recenzji i ponownym przejściu CI, możesz ponownie poprosić recenzenta o recenzję. Jeśli problem jest szczególnie skomplikowany, a jego rozwiązanie wpłynie na inną kwestię, możesz poprosić o recenzję konkretnego fragmentu, który zaktualizowałeś. Zakłada się, że każda prośba o recenzję jest prośbą o pełną recenzję. Jeśli nie jesteś gotowy na pełną recenzję, pamiętaj, aby dokładnie określić, czego oczekujesz.

Zatwierdzanie i scalanie pull requestów

Po udzieleniu odpowiedzi na wszystkie prośby o zmiany i ich zrealizowaniu, prośba o pull zostanie zatwierdzona. W większości przypadków, po zatwierdzeniu prośby o pull, natychmiast ją scalimy. W niektórych przypadkach mogą wystąpić okoliczności łagodzące, takie jak uzależnienie od innej, jeszcze nie scalonej prośby o pull, które spowodują opóźnienie. Poinformujemy o tym w komentarzach, abyś znał sytuację.