REVIEW.md - własne zasady przeglądu
REVIEW.md to plik w katalogu głównym repozytorium, który dostosowuje Code Review do zasad zespołu. Używaj go do określenia, co ma być zgłaszane, z jaką ważnością i co należy pomijać. Możesz dodać plik w podkatalogu, aby wprowadzić dodatkowe kontrole dla zmian w tej ścieżce.
Zasady zapisujesz jako swobodny tekst Markdown, który zmienia ustalenia przeglądu, ale nie jego format. Agenci wyszukujący i weryfikujący problemy otrzymują zawartość pliku jako instrukcje przeglądu repozytorium. Końcowy etap przeglądu korzysta z tych instrukcji, ustalając ważność i przygotowując podsumowanie.
Dodaj REVIEW.md w katalogu głównym, a następnie scal go z repozytorium i chroń domyślną gałąź. Przegląd odczytuje plik z gałęzi bazowej pull requesta albo z gałęzi domyślnej, nigdy z własnych zmian pull requesta. Aby zmienić zachowanie przeglądu, najpierw scal zmianę REVIEW.md.
Gdy chroniona jest domyślna gałąź, przegląd uwzględnia plik główny, dołączone pliki oraz pliki z podkatalogów. Dodatkowe pliki dołącza się w głównym REVIEW.md, wpisując w osobnej linii znak @ i nazwę pliku. Lokalna komenda /code-review czyta pliki CLAUDE.md, ale nie czyta REVIEW.md, więc zasady potrzebne w obu narzędziach umieść w CLAUDE.md.
Report at most five Nits per review.
Generated files under `src/gen/` and any `*.lock` file
- New API routes have an integration test
Zastosowanie w praktyce
Jeśli zespół otrzymuje zbyt wiele drobnych uwag, określ w REVIEW.md maksymalną ich liczbę na przegląd. Jeśli komentarze dotyczą plików generowanych lub kontroli już wykonywanych przez CI, wskaż odpowiednie ścieżki i kategorie problemów do pominięcia. Jeśli zespół chce egzekwować własną regułę, dodaj ją jako kontrolę stosowaną przy każdym pull requeście.
REVIEW.md zawartej w tym samym pull requeście, aby wpłynęła na jego przegląd: usługa odczytuje plik z gałęzi bazowej lub domyślnej, a nie ze zmian pull requesta.