Hogyan lehet szórakoztató (és nem rettenetes) a kódellenőrzéseket

Eleget tettem a kódellenőrzésekből. A méltányos részesedés alatt sokat értek. Végeztél már valaha egy epikus funkció kódellenőrzését? Nekem van. Nem volt nagy élmény, mert mire át kellett volna nézni a 100. fájlt, már fáradtan néztem a kódot. Olyan közel voltam ahhoz, hogy csak "Jaj, jól néz ki nekem" megyek, majd jóváhagyást adok.

De a kódellenőrzések nem így működnek. Miután elkezdte, ragaszkodnia kell ehhez és be kell fejeznie a végéig. Persze, tarthat szüneteket, de akkor elkezdi elveszíteni a kontextust, és mindent elölről kell kezdeni, így:

Eltérek azonban. Nem a fájdalomról kell beszélnem.

Tehát hogyan tegyük mondjuk kevésbé rettentővé? Először is, még a húzási kérelem benyújtása előtt, és még a kódolás megkezdése előtt, meg kell fontolnunk, hogy a funkciókat szép apró darabokra bontsuk. A fejlesztés és a telepítés gyorsabbá válik, mivel egy mini-funkciót mindig könnyebb telepíteni, mint egy epikusat. Ez megkönnyíti és gyorsítja a kódellenőrzéseket, mivel a változtatások meglehetősen kicsiek.

Nagy! Remélem tetszett a cikkem. Menjünk haza ...

Várj, állj meg !

Arról szólt, hogyan lehet kevésbé rettenetes, de mi lenne, ha szórakoztatóvá tenné?

Mémek használata a kód felülvizsgálatában

Jogi nyilatkozat: a következők a saját gondolataim, és nem a munkáltatóm.

Csak szerettem volna ezt félreállítani, mert ez potenciálisan ellentmondásos téma lehet. Különben is, mémek hozzáadásával könnyedén tesszük kódkritikáinkat.

Hallom, ahogy a szeme innét gördül! Hallgasd meg. Mi a jobb magyarázat, mint összekapcsolni valakit, aki már szívesen elmagyarázta?

A hangnem az, ami szórakoztatóvá teszi mind az ellenőr, mind az a személy számára, akinek kódját felülvizsgálják. Egy példa lenne a legelső „alap” image wallet. Észrevettem, hogy a Rubocopból hiányzik néhány kettős szóköz az aktáinkból, így amikor valaki egy kérelmet nyújtott be egy rakás extra szóközzel, nem volt okos dózist adni nekik.

Egyszerű kép volt, és mégis nagyon hatékony volt az üzenet. Emlékszem, hogy az emberek nevettek, amikor meglátták. Az emberek nem akartak „kutyázni”, ezért mindenki éberebb volt az extra fehér térben.

Könnyebb volt a keresőt megnyitni, a dogét megjegyzéshez és Please remove the extra whitespaceposzthoz húzni , ahelyett, hogy csak a sima régit írta volna be a húzási kérelembe (PR), különösen, ha több kutya volt.

Nem fordulhatna vissza?

Teljesen megteheti. Nem azt mondom, hogy mindenkinek követnie kell a csapatunkat. Ez valóban a csapat személyiségétől függ. A mieink átlagéletkora hat évvel fiatalabb, ami azt jelenti, hogy a legtöbb a mémekre vonatkozhat. Más lenne a helyzet, ha a csapatod átlagosan negyvenéves lesz (hacsak természetesen nem 4chan állampolgárok voltak, vagy naprakészek a legújabb mémekkel!).

Tényleg a csapattársaidat ismered a legjobban. Néhány hónapos együttlét után (főleg, hogy az esetek csaknem 100% -ában párosodtunk) valamennyire megéreztük egymás humorát, hogy úgy mondjam. Ez kényelmessé tette minket abban, hogy mémeket láthattunk a PR-ben, és csak nevettünk rajta (természetesen a probléma megoldása közben).

Milyen előnyök származnak a mémekből?

Nos, az egyik előnye, hogy gyorsabbá teszi a felülvizsgálatot (legalábbis nekem). Az a személy, aki benyújtotta a PR-t, valójában megérti, mit kell tennie gyorsabban. Néhány szó elolvasása helyett képet lát - és mindannyian tudjuk, hogy a képek hangosabban beszélnek, mint a szavak. Íme néhány példa az én personal image wallet™:

Amikor először hozok elő egy képet, leírást / magyarázatot adok arról, hogy mit kell megtenniük / kijavítaniuk. A fentiek alapvetően azt mondják, hogy távolítsák el a fenti „örökölt” kódot. Töröld. Pusztítsd el!

Ez kifejezetten a Ruby-ra vonatkozik - az pretzel dotoperátor alapvetően az a rövidítése try-catch. Csak kiemelem azt a részletet, amelyre perec kell, és illesszem be ezt a képet. Gyors és könnyű!

Ezt a kettőt csak felcserélhető módon használom újra és újra, Főleg a Ruby-ban, ahol mindig hozzáadjuk a # frozen_string_literal: truemágikus megjegyzést a fájl tetejéhez. Rubocoppal az élen azonban egyre kevesebben láthattuk Elsát és Mr. Freeze-t. Megjelennek minden olyan állandónál is, amely fagyasztásra szorul.

Ez elég egyértelmű (remélem). Amikor a kollégák ezt meglátják, ez annak a jele, hogy elírásuk volt. Általában a gépelési hibát is kiemelem, így gyorsan és könnyen áttekinthető (és javítható).

Ez csak néhány ezek közül. Ne feledje azonban, hogy túl sok minden általábannem jó dolog. Tehát csak vigyázzon, amikor hozzáadja a mémeket. A legjobb az is, ha nem ad hozzá túl sok mémet, mivel néha zavaró lehet. A megfelelő hangszínegyensúly megtalálása és az üzenet lehető leghamarabb történő elküldése a pull-lekérdezés legjobb módja.

Ez van, srácok

Összefoglalva: valóban rajtad múlik, ha szórakozni akarsz, vagy csak komoly és profi maradsz a munkahelyeden. Egyesek azt gondolhatják, hogy a mémek szakszerűtlenek - és biztos, hogy a hivatalos munkákban azok lehetnek. Lehet vitatni, hogy a lekérési kérelem lehet vagy egy formális munkával kapcsolatos dolog, de azt gondolom, hogy ez csak akkor érvényes, ha dokumentációhoz vagy áttekintéshez használja. Egyébként úgy gondolom, hogy ez a „szólásszabadság” (igen, húzta ki azt a kártyát!), És csak úgy kell venni, ahogy van.

Számomra azt közvetíti, amit mondani akarok: távolítson el extra szóközt, javítsa ki a helyesírást, fagyassza le az állandót, vagy távolítson el egy sort vagy kódsorokat. Nem kell sokat gépelnem, kolléganőmnek nem kell elolvasnia egy csomó szót egy másik szócsomó ellen, és ez kissé feldobja a hangulatot. Mindenki nyer! Ezzel befejezem ezt egy másik képemmel: