Code review dla Ciebie

Ostatnio piszę trochę o rekrutacjach więc czas zrobić też coś bardziej technicznego ale po części nadal pozostającego w tym temacie. Piszę o tym, że repozytorium do CV powinno być schludne, że warto dodawać swoje prywatne projekty itd. Jednak czasami początkująca osoba nie ma możliwości albo nie wie, że ma możliwość pokazania swojego kodu komuś bardziej doświadczonemu.

Z tego powodu zrodził się w mojej głowie pomysł na cotygodniowy cykl gdzie będę robił code review nadesłanych przez Was projektów. Chcę przez to podzielić się moją skromną wiedzą i jakoś wspomóc osoby, które nie są pewne czy idą ze swoim kodem w dobrą stronę. W zamian dostaję cotygodniowy materiał do publikacji i liczę, że czasami udostępnicie tekst w którym np. pojawia się Wasz projekt, także myślę, że to uczciwa wymiana.

Jak to działa?

Zasady są proste. Wyślij mi link do repozytorium na maila contact@zajacmarek.com. Oczywiście repozytorium musi być publiczne, żebym miał do niego dostęp.

Z nadesłanych projektów będę co tydzień wybierał ten, którego omówienie uznam za najbardziej wartościowe dla autora i czytelników. Komentarz udostępnię w formie posta na blogu w każdy weekend. Review będzie się skupiało na różnych aspektach, które zazwyczaj sprawdzam w standardowym code review w pracy, czyli formatowaniu, nazewnictwie, architekturze, ogólnej czystości kodu itp. W razie możliwości podpowiem jak coś mogło zostać wykonane opierając się na własnej wiedzy i ogólnie dostępnych źródłach.

Z racji, że pracuję w technologii .NET oraz JavaScripcie to raczej te technologie mogę najszerzej omówić. Ale nie skreślam od razu projektów pisanych w Javie czy Pythonie bo pewne zasady są uniwersalne i niezależne od wybranego języka.

Jeśli projekt będzie duży to zastrzegam sobie możliwość zrobienia review tylko części, która przyniesie największą wartość, i której poprawienie przyniesie autorowi najwięcej korzyści.

Regulamin

  • Projekt musi być dostępny w publicznym repozytorium, do którego link wysyłasz na adres contact@zajacmarek.com z tematem „Code review – zgłoszenie”
  • Wysyłając zgłoszenie zgadzasz się na umieszczenie fragmentów Twojego kodu oraz linku do repozytorium w poście na blogu zawierającym komentarz do code review
  • W emailu napisz jak chcesz być przedstawiony, czy ma to być imię (może z nazwiskiem?), pseudonim albo chcesz być anonimowy. W tym ostatnim przypadku nie zamieszczam linka do repozytorium
  • Możesz też wysłać projekt w formie paczki w mailu. W takim wypadku będę go brał pod uwagę w drugiej kolejności. Tak wysłany kod również może zostać we fragmentach upubliczniony na blogu
  • Zgadzasz się na możliwość pojawienia się krytycznych komentarzy i konstruktywnej krytyki
  • Projekty wybieram na podstawie subiektywnych kryteriów
  • Akcję kieruję przede wszystkim do osób, które zaczynają swoją przygodę z programowaniem
  • Sam nie poprawiam ani nie dopisuję niczego w Twoim kodzie. Jeżeli coś wymaga poprawy bądź czegoś brakuje jest to w Twojej gestii czy takie zmiany wprowadzisz

Co z tego masz?

Tak jak już wspomniałem taka akcja daje mi co tydzień materiał na bloga. A co daje Tobie?

Przede wszystkim zyskujesz możliwość oceny Twojego kodu przez osobę postronną. Nie znam Cię osobiście więc zawsze będę się starał pisać obiektywnie, rzeczowo i odpowiednio krytycznie. Dodatkowo dzięki upublicznieniu takiego code review możesz dostać feedback i więcej opinii również od moich czytelników. Także Twój projekt będzie bardzo dobrze sprawdzony.

Po drugie pisząc o wysyłaniu linków do repozytorium chcę Cię zachęcić do stworzenia takiego repozytorium, którym potem będziesz mógł się chwalić. A jeśli już takowe posiadasz to masz okazję jeszcze podnieść jego jakość. Dzięki temu unikniesz jednego z 4 błędów początkujących programistów.

Danie kodu do sprawdzenia pozwoli Ci też bardzo szybko zyskać nową wiedzę. Bo jest spora szansa, że dowiesz się o praktykach lub problemach, których nie byłeś świadomy i na które być może jeszcze długo byś sam nie trafił.

Liczę, że będzie to również dobry pretekst do szerszej dyskusji i wymiany wiedzy pomiędzy Tobą i pozostałymi czytelnikami – komentarze są Wasze ;)

 

W razie dodatkowych pytań pisz śmiało komentarz, wiadomość prywatną na Facebooku albo maila na adres contact@zajacmarek.com

Dodaj komentarz

Twój adres email nie zostanie opublikowany. Pola, których wypełnienie jest wymagane, są oznaczone symbolem *