Kuinka tehdä koodiarvosteluistasi hauska (eikä pelottava)

Olen tehnyt kohtuullisen osuuteni koodiarvosteluista. Oikeella osuudella tarkoitan paljon. Oletko koskaan tehnyt koodikatselmuksen eeppisestä ominaisuudesta? Minulla on. Se ei ollut hieno kokemus, koska kun 100. tiedosto oli tarkoitus tarkistaa, olin väsynyt katsomaan koodia. Olin niin lähellä vain mennä "Yup, näyttää hyvältä minulle" ja sitten antaa hyväksyntämme.

Mutta näin koodin tarkistus ei toimi. Kun olet aloittanut, sinun on pidettävä siitä kiinni ja viimeisteltävä loppuun asti. Toki, voit pitää taukoja, mutta sitten menetät kontekstin ja sinun on aloitettava kaikki uudestaan, kuten tämä:

Eron kuitenkin. Kipu ei ole se, mistä minun pitäisi puhua.

Joten miten voimme tehdä siitä esimerkiksi vähemmän pelottavan? Ensinnäkin, jo ennen vetopyynnön tekemistä ja jo ennen koodauksen aloittamista, meidän on tehtävä se, että ominaisuudet hajotetaan pieniksi pieniksi paloiksi. Kehitys ja käyttöönotto nopeutuvat, koska minitoiminnon käyttöönotto on aina helpompaa kuin eeppinen. Tämä tekee koodin tarkistamisen helpommaksi ja nopeammaksi, koska muutokset ovat melko pieniä.

Loistava! Toivottavasti pidit artikkelistani. Mennään kaikki kotiin ...

Odota, lopeta !

Kyse oli siitä, kuinka tehdä siitä vähemmän kauhea, mutta entä jos tekisit siitä hauskan?

Memeiden käyttö koodiarvioinnissa

Vastuuvapauslauseke: Seuraavat ovat omia ajatuksiani eikä työnantajani.

Halusin vain saada sen pois tieltä, koska tämä voi olla kiistanalainen aihe. Joka tapauksessa teemme koodiarvosteluistamme kevyet lisäämällä meemejä.

Kuulen silmäsi pyörähtävän täältä! Kuule minut. Mikä on parempi selitys kuin linkittää jonkun muun, joka selitti sen mielellään?

Sävy auttaa tekemään siitä hauskaa sekä arvostelijalle että henkilölle, jonka koodia tarkistetaan. Yksi esimerkki olisi minun ensimmäinen "katkottu" image wallet. Huomasin, että Rubocopista puuttui kaksoisvälilyöntejä tiedostoistamme, joten kun joku lähetti vetopyynnön, jossa oli joukko ylimääräistä tyhjää tilaa, ei ollut järkevää antaa heille koiraa.

Se oli yksinkertainen kuva, ja silti viesti oli erittäin tehokas. Muistan ihmisten nauravan nähdessään sen. Ihmiset eivät halunneet tulla koiriksi, joten kaikki olivat valppaina ylimääräisissä tiloissaan.

Oli helpompaa avata etsin, vetää doge kommenttiin ja lähettää sen sijaan, että kirjoittaisit vain tavallisen vanhan Please remove the extra whitespacevetopyyntöön (PR), varsinkin jos koiria oli useita.

Eikö se voisi palata takaisin?

Se voisi täysin. En sano, että kaikkien tulisi seurata tiimiämme. Se riippuu todella joukkueen persoonallisuudesta. Meidän keski-ikä on kuusi vuotta nuorempi, mikä tarkoittaa, että suurin osa voi liittyä meemeihin. Olisi erilainen tarina, jos joukkueellasi on keskimääräinen ikä neljäkymmentä (ellei tietenkään he olleet 4-kanavien kansalaisia ​​tai ovat ajan tasalla uusimpien meemien kanssa!).

Tunnet joukkuetoverisi parhaiten, todella. Muutaman kuukauden kuluttua olemisesta keskenämme (varsinkin kun olimme pariksi melkein 100% ajasta), tunsimme jonkin verran toistensa huumoria, niin sanotusti. Tämä teki meistä miellyttävän nähdä memejä PR: ssä ja vain nauraa siitä (tietenkin korjata asia).

Mitä hyötyä meemeistä saat?

No, yksi etu on, että se tekee tarkistamisen nopeammaksi (ainakin minulle). Henkilö, joka myös lähetti ilmoituksen, ymmärtää, mitä heidän on tehtävä nopeammin. Muutaman sanan lukemisen sijaan näet kuvan - ja me kaikki tiedämme, että kuvat puhuvat enemmän kuin sanat. Tässä on muutama esimerkki minun personal image wallet™:

Kun tuon kuvan ensimmäistä kertaa, lisätään kuvaus / selitys siitä, mitä heidän on tehtävä / korjattava. Yllä oleva sanoo periaatteessa poistavan yllä olevan "vanhan" koodin. Poista se. Tuhoa se!

Tämä on nimenomaan Ruby - pretzel dotoperaattori on periaatteessa oikotie a: lle try-catch. Korostan vain katkelman, joka tarvitsee suolaa, ja liitä tämä kuva. Nopea ja helppo!

Näitä kahta käytän vain vaihtokelpoisesti ja uudelleen, ENEMMÄN Ruby'ssa, johon lisätään aina taikakommentti # frozen_string_literal: truetiedoston yläosaan. Kun Rubocop on ruorissa, olemme nähneet yhä vähemmän Elsaa ja herra Freezea. Ne näkyvät myös kaikissa vakioissa, jotka tarvitsevat jäätymistä.

Tämä on melko suoraviivaista (toivon). Kun kollegat näkevät tämän, se on merkki siitä, että heillä oli kirjoitusvirhe. Korostan yleensä myös kirjoitusvirheen, joten se on nopea ja helppo nähdä (ja korjata).

Nämä ovat vain muutama niistä. Muista kuitenkin, että liikaa jotain on yleensäei hyvä asia. Joten ole varovainen, kun lisäät meemejäsi. On myös parasta olla lisäämättä liikaa meemejä, koska joskus se voi häiritä. Paras tapa kerätä vetopyyntö on löytää oikea äänen tasapaino ja lähettää viesti mahdollisimman nopeasti.

Siinä kaikki, ihmiset

Lopuksi on todellakin sinun tehtäväsi, jos haluat pitää hauskaa tai vain pysyä vakavana ja ammattimaisena työssä. Jotkut saattavat ajatella, että meemit eivät ole ammattimaisia ​​- ja varmasti, muodollisissa töissä ne saattavat olla. Voidaan väittää, että vetopyyntö voi olla muodollinen työhön liittyvä asia, mutta mielestäni se pätee vain, jos käytät sitä dokumentointiin tai arvosteluihin. Muuten luulen, että se on "sananvapautta" (jep, vedin kortin!) Ja sitä pitäisi vain ottaa sellaisenaan.

Minulle se välittää sen, mitä haluan sanoa: poista ylimääräinen välilyönti, korjaa oikeinkirjoitus, jäädytä vakio tai poista koodirivi tai -rivit. Minun ei tarvitse kirjoittaa paljon, kollegani ei tarvitse lukea joukko sanoja toista sanaa vastaan, ja se keventää mielialaa hieman. Kaikki voittavat! Tällä tavoin lopetan tämän toisella kuvallani: