Zasada skautów (97 rzeczy)

Polecam tekst Zasada skautów (The Boy Scout Rule by Uncle Bob) z serwisu 97 Rzeczy o których każdy programista wiedzieć powinien. Polecam przeczytać wszystko co tam jest. Następnie te, które nie zostały jeszcze przetłumaczone – przeczytać w oryginale i przetłumaczyć!

Boy scout rule in code
Boy scout rule in code source

Wracając do tytułowej zasady. Staraj się ją stosować w miarę możliwości. Wyrabia dobre nawyki.

„Zawsze wysyłaj do repozytorium moduł czystszy niż go zastałeś”

We wszystkim jednak należy zachować umiar. Dlatego też pod tym tekstem wywiązała się dyskusja i część osób zwracała uwagę, że tak sobie „poprawiając” można coś „popsuć”. Mylimy tutaj dwie rzeczy (trudno uchwytne). Według mnie ta zasada nie mówi o wielkim refactoringu (o którym to pewnie myśleli krytycy), który rzeczywiście zmienia więcej i może mieć efekty uboczne. Zasada ta odnośi się do prostych rzeczach, które ja, czytając kod (albo go kopiując) widzę. Widzę możliwy strzał lub powtórzenie, wiem jak prosto to poprawić i to robię. Ktoś kto pisał ten kod też by zauważył, gdyby go czytał drugi raz, ale wiadomo – spieszył się, napisał tylko raz.

Osobiście nie mogę czasem się powstrzymać jak widzę, że coś jest źle, a akurat jestem wokół tego kodu, znam kontekst i już wiem jak będzie dobrze. Może to te nieleczone ADHD, ale nie mogę się powstrzymać i poprawiam. Nawet bez taska w Jirze 😉

I jeszcze raz 97 Rzeczy.

2 Comments on “Zasada skautów (97 rzeczy)

  1. Tutaj należy być ostrożnym, ponieważ jeśli kod który wrzucasz do repozytorium przechodzi Code Review, to poprawki które wprowadzasz dodają pracy osobie sprawdzającej kod.

  2. @Lukasz: Argument wg mnie chybiony – zasada skauta oznacza sama z siebie więcej pracy. Jednak nie jest to praca bezowocna, czy też bezcelowa – każda mała cegiełka poprawia kod i powoduje, że jego przyszłe utrzymanie będzie odrobinę łatwiejsze. Z tego powodu dodatkowa, nikła, ilość pracy osoby sprawdzającej kod jest wg mnie nieistotna.