Hogyan használhatjuk a GitHub jelvényeket, hogy ne érezzük magunkat noobnak

Az Impostor-szindróma valóságos, és új fejlesztőket sújt. Végig egy oktatóanyagon, bootcampon vagy akár egy diplomán keresztül jutunk el, ennek ellenére továbbra is elzárkózunk a kód megosztásától. Attól tartunk, hogy negatív visszajelzés érkezik kódunk minőségére. Senki nem szenved ettől többet, mint az autodidakta fejlesztők. Mivel nincs semmiféle „valódi” vagy „hivatalos” tapasztalatunk vagy képzettségünk, a kódunkat alulírhatónak tartjuk.

Néhány hónapja ott voltam. Harry Percival tesztvezérelt fejlesztésén dolgoztam a Pythonnal . E ven ellenére, hogy követi végig a bemutató, én öntudatos megosztás kódomat. Annak ellenére, hogy az alkalmazás a várakozásoknak megfelelően működött, nem akartam megosztani a fejlődésemet. Nem akartam, hogy valaki valamilyen nyilvánvaló tévedés miatt hívjon fel, amelyről megfeledkeztem. Szerettem volna, ha más emberek is élvezik a termékemet, de nem akartam, hogy lássák, milyen szegény fejlesztő vagyok.

Miután szünetet tartottam a saját projektemben, elkezdtem vizsgálni néhány más projektet a GitHubon. Találtam néhányat, amelyeknek volt egy kis képük a README oldalaikon.

Most, hogy én voltam az a zug, azt gondoltam, hogy ez egyszerűen egy kép, amelyet Linus Torvalds pendrive-on adott át neked, amikor elvégezted a „Real Developer” iskolát. Egyszer sem fordult meg a fejemben, hogy rákattintottam. Azt hittem, hogy ez egy statikus kép, amelyet valahol a tárban tároltak. Később egy olyan projektbe botlottam, amely megmutatta, hogy az összeállítás nem sikerült.

Miért szánna valaki időt egy olyan kép hozzáadására, amely szerint a felépítésük nem múlik el? Miért kell azon törekedni, hogy levegye a másik képet, feltegye ezt? Egy kép, amely azt állítja, hogy a projekt nem működik, és megjeleníti azt a világ számára? Merő kíváncsiságból felhúztam a README nyers formátumát. Láttam ezt a kódot:

[![Build Status](//travis-ci.com/username/projectname.svg?branch=master)](//travis-ci.com/username/projectname)

Elég hozzáértő voltam a jelöléssel, hogy felismerjem, hogy ez egy kattintható link volt. Tehát rákattintottam a gombra, és elvitt a Travis-CI-be. Egyszerre volt értelme számomra. Ezt a gombot a projektfejlesztő nem frissítette, a Travis-CI frissítette. Ez egy dinamikus gomb.

Az első jelvényem

Tehát, miután megtudtam az építési jelvényt a Travis-CI-től, rendelkeznem kellett vele a projektemhez. Végül is az egész projektem a tesztek írásáról és használatáról szólt. Akkor miért ne lenne valami, ami automatikusan futtatta volna őket?

Tehát úgy állítottam be a Travis-CI-t, hogy futtassam az egység tesztjeimet, amikor a GitHub-ra változtattam. A Travis-CI által üzemeltetett oldal tetején ott van a jelvény. Rákattintottam, és megkaptam a jelölést. Hozzáadtam a README-hez. A GitHub és a VOILA projekt oldalára navigáltam! Ott volt az első kitűzőm. Rákattantam!

Vadászat

Élveztem, hogy a jelvény egyértelmű jele volt a projektem jelenlegi állapotának. Szerettem volna többet megtudni, ezért más jelvényekre vadásztam. Egy másik gyakori jelvény, amelyet találtam, a kód lefedettsége volt. A lefedettségi jelentést a Travis-CI elküldhette a CodeCov nevű eszköznek. Kaphat egy jelvényt, amely a tesztek lefedettségét jelzi, amely összefügg az alkalmazás tesztelésének sikerességével.

Találtam licencjelvényeket is, és csak akkor volt értelme licencjelvény birtoklásának, ha licencem volt. Ezért választottam egy licencet, és hozzáadtam a repóhoz. A jelvény megszerzéséhez gyors Google Search kellett, és megtaláltam ezt a lényeget az összes általános licencjelzővel együtt.

A katonaság biztonsági hátteréből származva tudom, hogy a legtöbb sebezhetőség korszerűtlen szoftverekből származik. Új fejlesztőként tudom, hogy ez vonatkozik azokra a szoftverekre is, amelyeken a szoftvere függ. A PyUpról Michael Kennedy Talk Python to Me podcastján keresztül hallottam . Amikor eljutottam a webhelyre, megláttam azokat a szavakat, amelyeket már nagyon szerettem látni: „Ingyenes a nyílt forráskódért”. Új jelvények vadászatában szerencsém volt. Valóban, adnak kitűzőt, ezért természetesen hozzáadom a README-hez.

Végül rájöttem, hogy lehet stílusjelvény. Korábban már összevesztem Black-el, és találtam egy példát a stílusjelvényre, és tudtam, hogy rendelkeznem kell vele. Saját integritásom érdekében szerettem volna biztosítani, hogy a kódom mindig megfeleljen Black stílusának. Megtudtam az előzetes elköteleződést, amellyel formázhattam a kódomat, mielőtt még elkövettem volna. Miután elmerültem az elkövetés előtti nyúl lyukán (amely a biztonsági kóddal is futtatja a kódomat a bandita ellen, és rendezi az importot és a követelményeket), magabiztosnak éreztem, hogy a Fekete jelvényt felvettem a README-be.

A végeredmény

A vadászjelvények első eredménye, hogy jobb minőségű projektem van . Hozzáadtam egy licencet a projektemhez, biztosítottam, hogy a függőségeim naprakészek maradjanak, és a projektstílusomat megfelelőnek tartottam, mert a jelvényeket akartam.

Különösen abban, hogy jobban bízom a projektemben. Beszélhetek róla, tudván, hogy nincsenek benne tátongó lyukak. Tudom, hogy sokkal kevésbé kapok visszajelzést a biztonsággal kapcsolatos felelőtlenségemről vagy a stílusok betartásának hiányáról.

Leegyszerűsítve: jobban érzem magam a kódomban, mert megvannak azok a GitHub jelvények.