Jak powinno wyglądać code review?

Jak powinno wyglądać code review?

Wątek przeniesiony 2023-12-06 14:00 z Kariera przez Riddle.

Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:19 minut
  • Lokalizacja:Laska, z Polski
  • Postów:10048
4

Tak jak się teraz zastanawiam, to to pytanie jest zadane odwrotnie. Pytanie nie powinno brzmieć "jak ma wyglądać Code review"?

Autor powinien zadać pytanie "co daje Code review?" i wtedy spróbować odnieść to do swojej aktualnej sytuacji.

G8
  • Rejestracja:około 3 lata
  • Ostatnio:około rok
  • Postów:2000
1

Tak to sobie można dyskutować, wszystko zależy od tego czy to rzeczywiście autor robi wzystko dobrze, a to tylko złośliwie ktoś się do niego czepia bez powodu, czy robi jednak kupę albo z lenistwa albo z braku wiedzy i raczej jest odporny na wiedzę.

To można by było stwierdzić, gdyby podał jakiś konkretny przykład co mu kazano zrobić, ale tego nie mówi.

WeiXiao
  • Rejestracja:około 9 lat
  • Ostatnio:około 2 godziny
  • Postów:5105
1

@Riddle

Z code review nie ma to za wiele wspólnego - nie pełni to funkcji korekt/poprawek, tylko raczej przymuszania do konwencji/rozwiązań (ewentualnie czasem może pełnić też funkcję "mentorowania" że senior blokuje zmiany juniora kiedy mają jakiś oczywisty błąd, ale to rzadko).

W takich wypadkach najczęstsze przyczyny "odrzucenia" PR'a to:

nie dopasowanie się do jakiejś konwencji, stylu
umieszczenie kodu w "złych" miejscach (i mówiąc "złych" mam na myśli w odejściu od aktualnej konwencji)
literówki

Każda z tych wymienionych jest zasadna, jednakże PRa się nie odrzuca, a daje do niego komentarze.

Jeżeli cały kod jest pisany w jakimś stylu, korzysta z jakiegoś konkretnego podejścia, to odejście od niego bez dobrych argumentów nie ma sensu.
Po prostu spowalniasz czytających ten kod, tyle.

Umieszczanie kodu w miejscach innych niż powinny również jest chyba dość oczywiste, tak samo literówki?

Nie rozumiem twojej krytyki konwencji - co do zasady są one dobre, bo przyśpieszają pracę.

Ale pomysł z gate-keepowaniem w organizacji, do którego dostęp mają tylko osoby które podpisały z nami umowę, i mamy do nich zaufanie - raczej nie jest na plus.

Ma sens, bo bycie w organizacji nie implikuje braku błędów czy gorszych dni.

Poziom 0: Pull Requesty -
Obniża zaufanie do innych programistów, budzi poczucie że musimy "pilnować" dostępu przed "złymi zmianami".

Każda zmiana z reguły wymaga istnienia odpowiedniego taska w jirze (co utrudnia wprowadzanie refaktorów lub poprawek nie związanych z taskami)

To już jakieś twoje wymysły, nie są to cechy PRów.

Poziom 1: Mentorowanie,
Zalety:
Reviewerowi łatwiej jest checkoutować kod, i faktycznie go uruchomić na swojej maszynie - to jest ogromny plus na pull requestami (gdzie praktycznie nikt nie checkoutuje kodu

Jeżeli ktoś uznaje że potrzebuje kod przeanalizować lokalnie z IDE to nikt mu przy PRach zrobić tego nie broni, sam tak robię gdy jest coś, co wymaga tego.

Od uruchamiania kodu i testów jest CI, które zrobi to zanim w ogóle reviewer pomyśli o robieniu review.

Poziom 2: Pair programming

Zalety:
Feed-back loop jest praktycznie zerowy, dlatego że review następuje podczas pisania kodu
Lepszy design, dlatego że mentor aktywnie bierze udział w powstawaniu rozwiązania
Bardzo dobry knowledge-sharing
Wady:
Praktycznie żadnych
Jedyną jaka jest to to, że ludzie którzy tego nie próbowali, bardzo się obawiają tego spróbować
Istnieje powszechne przekonanie że pair programming jest wolniejszy niż "normalne developowanie"

Wady:

  • strata czasu jeżeli klepany kod jest czymś standardowym/prostym/nudnym/whatever
  • łatwiej namówić się na nieprzemyślane rozwiązania, które dopiero po dłuższej analizie, na spokojnie, okazują się nie sprawdzać.

@adamKowal

zapominają dla kogo piszą ten kod i czy dla biznesu lepiej będzie jeśli zostanie dowiezione wcześniej czy metoda zostanie przerobiona pod dyktando seniora dla zwiększenia czytelności DLA programistów jakby programisci byli w tym nawazniejsi. Soft jest pisany dla klienta. Bo ja jestem zorientowany na biznes, pisze dla biznesu przede wszystkim i nie chce poswiecac kolejnego dnia na dostosowywanie kodu, bo panom programistom lepiej będzie się czytać w przyszłości lub będą zadowoleni że jest napisane zgodnie z najnowszymi standardami. Chodzi o to że niektórzy programiści przedkładają idealnosc kodu ponad biznes i zawsze debilnie tłumacza to tym że musi tak być bo przez to cala aplikacja się rozjebie za 5lat

Jak znajdziesz magiczny stosunek (upiększania kodu) do (tworzenia wartości biznesowej), który będzie optymalny, to pewnie mógłbyś jakąś fajną nagrodę dostać, albo taczkę pieniędzy.

Niestety oba podejścia - nieskończone polerowanie kodu, jak i zaciąganie nieskończonego tech debtu mogą spowolnić lub ubić projekt, lub nawet firmę.

Jak określić jakie proporcje przyjąć? nie wiem, prawie każdy pewnie stara się to robić intuicyjnie, na podstawie doświadczenia, analiz czy dyskusji.

Bez kontekstu nie jesteśmy w stanie ocenić czy ci seniorzy robią dobrą robotę.

Może tak jak napisał - @Yarilo - przed zaczęciem kodzenia może powinieneś pogadać o tym jak planujesz to zrobic? idk

edytowany 14x, ostatnio: WeiXiao
DE
  • Rejestracja:ponad rok
  • Ostatnio:ponad rok
  • Postów:14
0
lsikora napisał(a):

@adamKowal
Mnie nie śmieszy. Nie raz i nie dwa widziałem, jak mina którą wieszczył reviewer wybucha szybciej niż ktokolwiek się spodziewał. Czsem junior zrobił merge bez poprawiania (jeden mi się taki zdażył w życiu) a czasem była świadoma zgoda na dług techniczny.

Idąc za klasyką psychologii, macie probelm w komunikacji.
Na twoim miejscu, jak czujesz że komentarze są niepotrzebne, to omówiłbym je całym zespołem. I ustalił zasady jak postępować w danej sytuacji. Lub pair programming, żeby wszystkie strony zrozumiały swój sposób myśłenia. Lub prosiłbym o wytłymaczenie do każdego spornego komentarza, dlaczego ma być inaczej i czy zmiana jest wymagana nawet jak opóźni dostarczenie.

Mietek z budowy: robi żeby skończyć szybciej i dostać wypłatę, choćby odwalił fuszerkę to ch0ja mu zrobisz. Jest zrobione i ma być wyplata. Programista nadgorliwiec: Sam kręci na siebie bata, sługa, asceta, dobrowolny niewolnik, doszukuje się co by tu jeszcze poprawić w kodzie, kosztem niedowiezienia sprintu, świr, będzie poprawiał 2 spacje na taby żeby zaspokoić swoje autystyczne wizje. Programiści to największe cioty, które dają się wyzyskiwać kompletnie nie rozumieją jak działa biznes, nie cenią swojego czasu, po pracy nadal klepią kod.
Budowlaniec prawdziwy mężczyzna z krwi i kości - dominujący, ceni siebie, swój czas i jak przychodzi ci zrobić remont na chacie to musisz go sam pilnować, doglądać żeby się nie obijał.
Programista mięczak, virgin boy, drży ze strachu że w kodzie metoda nie jest napisana zgodnie z DRY i jego amerykański Pan się obrazi albo kodzik będzie nieczytelny.
Nie wiem z czego to wynika takie poniżanie się, brak szacunku do swojego czasu, chęć zaimponowania kodem. Podejrzewam że w życiu prywanym są niedowartościowaniu więc dla nich ten kod jest święty, więc mają potrzebę ciagłego samobiczowania się?

Sto razy wolałbym pracować z ekipą takich mentalnych Mietków dla których szef jest złodziejm januszem, którzy zazdroszczą mu że dzięki ich pracy kupuje sobie co miesiąc nowe BMW. To jest zdrowe podejście. Robienie minimum, dbanie przede wszystkim o swój interes, czas i pieniądze.
Praca z takimi nerdami programistami którzy od 10 roku życia spędzają 12 godzin przed komputerem to udręka. Oni skłonni są robić darmowe nadgodziny, bo są podnieceni faktem śledzenia buga w kodzie, dla nich to rozrywka. Jak jesteś gościem z zyciem prywatnym, rodziną, dziećmi który ceni sobie czas, pieniądze, chce mieć życie po pracy to nie wytrzymasz w pracy jako programista bo takich dzieci mentalnych którzy nie myśla pieniędzmi w IT jest na pęczki

edytowany 1x, ostatnio: devhops
Miang
właśnie robi u mnie różne roboty remontowe gościu który byłby świetnym programistą albo inżynierem w innej dziedzinie, dyskutuje ze mną swoje propozycje, potrafi wziąć pod uwagę podane przez mnie warunki brzegowe, no i nie muszę go pilnować bo widać ze ma też dumę ze swojej pracy.
G8
  • Rejestracja:około 3 lata
  • Ostatnio:około rok
  • Postów:2000
6

LOL

Ty nawet nie rozumiesz, że właśnie jak piszesz gówniany kod to kręcisz na siebie bata. Bo potem przykleja się stopniowo coraz więcej i więcej gówna w miarę upływu czasu a potem się okazuje że już nic nie możesz tam zrobić i okazuje się że już niczego nie dowieziesz z tą różnicą że nic nie możesz na to poradzić, a gdziekolwiek nie dotkniesz nie wiadomo co się popsuje.

Więc robienie czegoś dobrze nie jest w interesie biznesu tylko w twoim własnym, bo to co zrobisz źle teraz zemści się na tobie później.

I dlatego jeśli robisz code review, a przyjdzie ci ktoś, nawali staticów, singletonów czy zmiennych globalnych bo gdyby tego nie zrobił to by nie dowiózł taska, to mimo to odrzucasz i piszesz w review że tak się nie robi

edytowany 1x, ostatnio: gajusz800
Miang
ale jak on nie umie tak czy inaczej czytać kodu to żadna różnica ;)
Miang
  • Rejestracja:prawie 7 lat
  • Ostatnio:3 minuty
  • Postów:1659
2

no i właśnie tak się kończy wiara w mityczny zespół, w którym wszystko się razem ustala i dogaduje , ja tam jestem zwolenniczką jakieś hierarchii , oczywiście takiej hierarchii w której with great power comes great reponsibility


dzisiaj programiści uwielbiają przepisywać kod z jednego języka do drugiego, tylko po to by z projektem nadal stać w miejscu ale na nowej technologii
G8
Dokładnie, jak wszyscy decydują to nie ma żadnej decyzji. Ktoś musi mieć decydujące zdanie i brać za to odpowiedzialność
MU
To korpo wydaje się idealnym miejscem dla Ciebie
Miang
w korpo nie ma odpowiedzialności
MU
Tak jak i w innych miejscach gdzie jest pseudo hierarchia
jarekr000000
  • Rejestracja:ponad 8 lat
  • Ostatnio:około 3 godziny
  • Lokalizacja:U krasnoludów - pod górą
  • Postów:4706
9
Miang napisał(a):

no i właśnie tak się kończy wiara w mityczny zespół, w którym wszystko się razem ustala i dogaduje , ja tam jestem zwolenniczką jakieś hierarchii , oczywiście takiej hierarchii w której with great power comes great reponsibility

A mi zupełnie wszystko jedno czy decyduje zespół, czy hierarchia - ważne, żeby było tak jak ja chcę.


jeden i pół terabajta powinno wystarczyć każdemu
PaulGilbert
  • Rejestracja:około 7 lat
  • Ostatnio:około 3 godziny
  • Postów:913
1

Nie wiem, czy ktoś już to pisał, ale pytanie czy tylko Ty w całym teamie masz taki problem z code review, czy wszyscy tak mają i wszystkich to wkurza, ale każdy siedzi cicho. Jeśli tylko Ty, to raczej pewnie coś rzeczywiście nie halo zwykle z Twoim kodem, natomiast jeśli wszyscy się wkurzają, bo ktoś rzeczywiście wymyśla za bardzo to pogadaj z ludźmi żeby zrobić spotkanie w celu przegadania tego. Zwykle to pomaga.

markone_dev
  • Rejestracja:około 3 lata
  • Ostatnio:7 dni
  • Postów:809
0

Chętnie bym poznał opinię drugiej strony bo jak na razie to wygląda jak w sprawie dla nosacza "pani redaktur, przynieśli, my nie przeczytali, podpisali, a tera cza płacić"


Programujący korpo architekt chmurowy.
Udzielam konsultacji i szkoleń w obszarze szeroko pojętego cloud computingu (Azure, AWS) i architektury systemów IT. Dla firm i prywatnie.
DevOps to proces nie stanowisko.
edytowany 3x, ostatnio: markone_dev
SL
  • Rejestracja:około 7 lat
  • Ostatnio:33 minuty
  • Postów:859
0

Zależy od specyfiki produktu i środowiska pracy. Google zaleca making small progress, bo mają dobrą infrastrukturę na około całego cyklu developmentu i nawet jak coś ktoś zepsuje to nie ma tragedii. Po drugiej stronie spektrum masz aplikacje monolity, gdzie wrzucenie czegoś błędnego na proda to katastrofa.

Niestety nie da się wyrokować bez poznania konkretów

loza_prowizoryczna
  • Rejestracja:ponad 2 lata
  • Ostatnio:dzień
  • Postów:1592
1

Pomyślmy w taki sposób - czy chcecie żeby atomową futbolówkę odpalała jedna osoba na życzenie czy lepiej żeby to skonsultowała z kolegami?

Nawet jak odpali i nastąpi dzień zagłady to zawsze przed Bogiem i historią będzie mogła stwierdzić że ten drugi nie miał żadnych zastrzeżeń.


Przetrzyma wszystko
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)