Code review

Dlaczego?

  • Poprawa jakości
  • Dodatkowa weryfikacja 
  • Dzielenie wiedzy o projekcie
  • Nauka indywidualna

Braki w procesie code review dają nam fałszywe poczucie jakości/bezpieczeństwa

Team effort

Kod do danego taska zazwyczaj tworzy jedna osoba ale całość dowozimy jako zespół. Code review jest integralną częścią procesu i nie powinniśmy zostawiać tego na ostatnią chwilę.

Code Work review

  • Czy kod spełnia wymagania opisane w tasku?
  • Czy nie wybiegamy poza zakres danego taska?
  • Czy napisaliśmy odpowiednie testy?
  • Czy dopisaliśmy odpowiednią dokumentacje?
  • Czy wzięliśmy pod uwagę dodatkowe rzeczy które początkowo nie były w zakresie? (np loadery)

Funkcja nie syntax

Nie skupiajmy się na detalach jak coś zostało zaimplementowane a na szerszej perspektywie. Nie traćmy czasu na dyskusje o preferencjach syntaxu A nad syntaxem B

const fun1 = function () {
    ...
}

function fun2() {
    ...
}

const fun3 = () => {
    ...
}

Code style guide

Sporne kwestie rozwiążmy na początku i spiszmy w postaci kontraktu.

  • Linter
  • Architektura
  • Design patterns
  • Library/method preferences

Koszt pośpiechu

Dług techniczny

Nie bójmy się korzystać z długu technicznego.

Trzymajmy dyscypline w śledzeniu go i stopniowym rozwiązywaniu.

Good practices

  • Self-review przed review od zespołu

  • Code review request kiedy PR jest w 100% gotowy

  • Przetestowanie lokalne ficzera - nie tylko review na github.

  • Ułatwmy review dla zespołu na tyle na ile to możliwe

    • Dodanie komentarzy w PR w miejscach o których wiemy że mogą wzbudzić wątpliwości

    • Opisanie drogi która doprowadziła nas do danego rozwiązania

    • Dodanie screenshotów

    • Podlinkowanie w opisie wszystkich powiązanych źródeł

Code review

By vrael560

Made with Slides.com

Code review

  • 322

More from vrael560