Lista kontrolna przeglądu pull requestu
Lista kontrolna recenzenta, która wychwytuje rzeczy, które ludzie tak naprawdę przegapiają. Wklej go do szablonu opisu PR lub użyj go jako zachęty do osobistej recenzji.
Pobierz .md
# Lista kontrolna przeglądu PR Przejdź się po tej liście, zanim klikniesz „Zatwierdź”. Jeśli coś nie jest zaznaczone, zamiast tego zostaw komentarz. ## Zakres - [ ] PR robi jedną rzecz; tytuł opisuje tę rzecz w jednym wierszu - [ ] Żadne refaktoryzatory typu drive-by nie są powiązane ze zmianą - [ ] Diff mieści się w Twojej głowie (< 400 linii lub podział) ## Poprawność - [ ] Spełnione są kryteria akceptacji z połączonego zadania - [ ] Obsługiwane przypadki Edge: puste wejście, maksymalne wejście, równoczesne połączenia, awaria sieci - [ ] Wykluczono błędy typu off-by-one i strefy czasowej - [ ] Ścieżki błędów zwracają przydatne błędy, a nie ciche awarie ## Testy - [ ] Nowy kod ma testy; co najmniej jeden na każde kryterium akceptacji - [ ] Testy potwierdzają zachowanie, a nie implementację - [ ] Testy faktycznie by się nie powiodły, gdyby kod uległ regresji - [ ] Nie `skip`, `xit`, `it.only`lub skomentowane twierdzenia ## Czytelność - [ ] Nazwy opisują intencję, a nie typ czy pozycję - [ ] Komentarze wyjaśniają DLACZEGO, a nie CO - [ ] Żadnych magicznych liczb, żadnych bloków typu „kopiuj i wklej”. - [ ] Udokumentowane publiczne interfejsy API ## Bezpieczeństwo - [ ] Dane wprowadzone przez użytkownika zostały zatwierdzone na granicy - [ ] Żadnych sekretów/tokenów/kluczy w kodzie i testach - [ ] Sprawdzono autoryzację, a nie tylko uwierzytelnienie - [ ] Brak nowej powierzchni SQL Injection/XSS/SSRF ## Wydajność - [ ] Wykluczono N+1 zapytań (licz zapytania w testach) - [ ] Żadnych nieograniczonych pętli ani nieograniczonych zestawów wyników - [ ] Dodano indeksy dla nowych wzorców zapytań - [ ] Ciężka praca w tle, a nie w cyklu żądań ## Operacje - [ ] Migracje są odwracalne (lub jawnie tylko do przodu) - [ ] Dodano flagę funkcji dla ryzykownych zmian - [ ] Dodano dzienniki/metryki dla nowych przepływów - [ ] Element Runbook/dokumenty zaktualizowany w przypadku zmiany zachowania ## Zatwierdź / poproś o zmiany - **Zatwierdź** jeśli każde pole jest zaznaczone - **Poproś o zmiany** jeśli jakakolwiek blokada nie jest zaznaczona - **Komentarz** jeśli masz sugestie, ale nie masz blokad --- Definicja słownika Gotowe: https://sprintflint.com/glossary/definition-of-done
# Lista kontrolna przeglądu PR
Przejdź się po tej liście, zanim klikniesz „Zatwierdź”. Jeśli coś nie jest zaznaczone, zamiast tego zostaw komentarz.
## Zakres
- [ ] PR robi jedną rzecz; tytuł opisuje tę rzecz w jednym wierszu
- [ ] Żadne refaktoryzatory typu drive-by nie są powiązane ze zmianą
- [ ] Diff mieści się w Twojej głowie (< 400 linii lub podział)
## Poprawność
- [ ] Spełnione są kryteria akceptacji z połączonego zadania
- [ ] Obsługiwane przypadki Edge: puste wejście, maksymalne wejście, równoczesne połączenia, awaria sieci
- [ ] Wykluczono błędy typu off-by-one i strefy czasowej
- [ ] Ścieżki błędów zwracają przydatne błędy, a nie ciche awarie
## Testy
- [ ] Nowy kod ma testy; co najmniej jeden na każde kryterium akceptacji
- [ ] Testy potwierdzają zachowanie, a nie implementację
- [ ] Testy faktycznie by się nie powiodły, gdyby kod uległ regresji
- [ ] Nie `skip`, `xit`, `it.only`lub skomentowane twierdzenia
## Czytelność
- [ ] Nazwy opisują intencję, a nie typ czy pozycję
- [ ] Komentarze wyjaśniają DLACZEGO, a nie CO
- [ ] Żadnych magicznych liczb, żadnych bloków typu „kopiuj i wklej”.
- [ ] Udokumentowane publiczne interfejsy API
## Bezpieczeństwo
- [ ] Dane wprowadzone przez użytkownika zostały zatwierdzone na granicy
- [ ] Żadnych sekretów/tokenów/kluczy w kodzie i testach
- [ ] Sprawdzono autoryzację, a nie tylko uwierzytelnienie
- [ ] Brak nowej powierzchni SQL Injection/XSS/SSRF
## Wydajność
- [ ] Wykluczono N+1 zapytań (licz zapytania w testach)
- [ ] Żadnych nieograniczonych pętli ani nieograniczonych zestawów wyników
- [ ] Dodano indeksy dla nowych wzorców zapytań
- [ ] Ciężka praca w tle, a nie w cyklu żądań
## Operacje
- [ ] Migracje są odwracalne (lub jawnie tylko do przodu)
- [ ] Dodano flagę funkcji dla ryzykownych zmian
- [ ] Dodano dzienniki/metryki dla nowych przepływów
- [ ] Element Runbook/dokumenty zaktualizowany w przypadku zmiany zachowania
## Zatwierdź / poproś o zmiany
- **Zatwierdź** jeśli każde pole jest zaznaczone
- **Poproś o zmiany** jeśli jakakolwiek blokada nie jest zaznaczona
- **Komentarz** jeśli masz sugestie, ale nie masz blokad
---
Definicja słownika Gotowe: https://sprintflint.com/glossary/definition-of-done
Przestań wypełniać szablony.
SprintFlint przeprowadzi za Ciebie sprint (pojemność, prędkość, retro, spalanie) bez szablonu, dzięki któremu będziesz na bieżąco.