Kuidas kasutada GitHubi märke, et peatada end nooblikuna

Foto Jakob Owens saidil Unsplash

Impostori sündroom on tõeline ja vaevab uusi arendajaid. Saame kõik läbi õpetusest, alglaadimiskambrist või isegi kraadist, kuid me siiski häbeneme oma koodi jagamist. Kardame negatiivset tagasisidet meie koodi kvaliteedi kohta. Keegi ei kannata selle all rohkem kui iseõppinud arendajad. Kuna meil ei ole mingit “tõelist” ega “ametlikku” kogemust ega väljaõpet, peame meie koodi alamparlamendiks.

Olin seal paar kuud tagasi. Töötasin läbi Harry Percivali katsetega arendatava arendamise Pythoni kaudu. Ehkki jälgisin õpetust koos, olin oma koodi jagamise osas ise teadlik. Ehkki minu rakendus töötas ootuspäraselt, ei soovinud ma oma edusamme jagada. Ma ei tahtnud, et keegi helistaks mulle mingi ilmse vea pärast, mille olin unustanud. Ma tahtsin, et teised inimesed saaksid mu tootest rõõmu tunda, kuid ma ei tahtnud, et nad näeksid, kui vaene ma arendaja olin.

Pärast pausi enda projektist hakkasin GitHubis vaatama mõnda muud projekti. Leidsin mõned neist, millel oli nende README lehtedel vähe pilti.

Olles noobel, kes ma olin, arvasin, et see on lihtsalt pilt, mille Linus Torvalds andis teile reaalarendaja kooli lõpetamisel mälupulgale. Kunagi pole see minu arust klõpsanud. Arvasin, et see on staatiline pilt, mida hostitakse kuskil hoidlas. Hiljem komistasin projekti peale, mis näitas, et ehitamine ebaõnnestus.

Miks peaks keegi võtma aega pildi lisamiseks, mille kohaselt nende ehitamine ei möödu? Miks minna läbi teise pildi mahavõtmise ja selle ülespanemise püüdlustest? Pilt, mis ütleb, et teie projekt on katki ja kuvage see maailmale vaatamiseks? Tõmbasin puhtast uudishimust üles README toore formaadi. Ma nägin seda koodi:

[! [Ehituse olek] (https://travis-ci.com/username/projectname.svg?branch=master)] (https://travis-ci.com/username/projectname)

Olin markimisest piisavalt osav, et aru saada, et see oli klõpsatav link. Klõpsasin nuppu ja see viis mind Travis-CI-sse. Korraga oli see minu jaoks mõistlik. Projekti arendaja seda nuppu ei värskendanud, Travis-CI värskendas seda. See on dünaamiline nupp.

Minu esimene märk

Niisiis, kui sain teada Travis-CI ehitamismärgist, pidin see minu projekti jaoks olemas olema. Lõppude lõpuks oli kogu minu projekt seotud testide kirjutamise ja kasutamisega. Miks ei võiks olla midagi, mis neid automaatselt käivitaks?

Nii et ma seadsin Travis-CI oma ühikatsetuste läbiviimiseks, kui tõukasin muudatusi GitHubile. Lehe ülaosas, kus Travis-CI neid juhib, on märk. Klõpsasin seda ja sain juurdehindluse. Lisasin selle oma README. Liikusin projekti lehele GitHubis ja VOILA-s! Seal oli mu esimene märk. Ma olin konksul!

Jaht

Mulle meeldis, et märk oli selge märk minu projekti hetkeseisust. Tahtsin rohkem teada saada, nii et läksin teiste aumärkide jahtima. Teine levinud märk, mille leidsin, oli koodide katvus. Travis-CI võib leviaruande saata tööriistale nimega CodeCov. Võite saada märgi, mis näitab teie testide katvust, mis korreleerub teie rakenduse testimise edukusega.

Samuti leidsin litsentsimärgid ja litsentsimärgi omamine oli mõistlik ainult siis, kui mul oleks litsents. Nii et valisin litsentsi ja lisasin selle reposse. Selle märgi saamine võttis kiire Google'i otsingu ja ma leidsin selle sisu koos kõigi tavaliste litsentsimärkidega.

Tulles sõjaväe julgeoleku taustast, tean, et enamik haavatavusi tuleneb vananenud tarkvarast. Uue arendajana tean, et see kehtib ka tarkvara kohta, millest teie tarkvara sõltub. Kuulsin PyUpist Michael Kennedy Talk Python to Me podcasti kaudu. Saidile navigeerides nägin sõnu, mida mulle hakkas meeldima, „tasuta avatud lähtekoodiga”. Uute märkide otsimisel oli mul õnne. Muidugi, nad annavad märgi, nii et loomulikult lisan selle README-sse.

Lõpuks avastasin, et sul võib olla stiilimärk. Segasin mustaga varem ringi ja leidsin stiilimärgi näite ning teadsin, et see mul peab olema. Enda terviklikkuse huvides soovisin veenduda, et minu kood vastab alati Musta stiilile. Sain teada eelkinnituse kohta, mida sain kasutada oma koodi vormindamiseks enne selle sidumist. Pärast eelküüliku küüliku auku sukeldumist (mis juhib turvalisuse tagamiseks ka minu koodi bandiidi vastu ja sorteerib minu importi ja nõudeid), tundsin end kindlalt, kui lisasin oma README-le musta märgi.

Lõpptulemus

Jahindusmärkide esimene tulemus on see, et mul on parema kvaliteediga projekt. Lisasin oma projektile litsentsi, tahtsin, et mu sõltuvused oleksid ajakohased, ja hoidsin projekti stiili nõuetele vastavana, kuna soovisin rinnamärke.

Täpsemalt olen ma oma projektis kindlam. Ma võin sellest rääkida, teades, et selles pole ühtegi ava. Ma tean, et olen palju vähem tõenäoline, et saan tagasisidet oma vastutustundetuse kohta turvalisuse osas või stiili mittetäitmise osas.

Lihtsalt öeldes tunnen, et tunnen oma koodi paremini, kuna mul on need GitHubi märgid.