18 KiB
Uvod u GitHub
Ova lekcija pokriva osnove GitHuba, platforme za hostanje i upravljanje promjenama u vašem kodu.
Sketchnote autorice Tomomi Imura
Kviz prije predavanja
Uvod
U ovoj lekciji obradit ćemo:
- praćenje rada na vašem računalu
- rad na projektima s drugima
- kako doprinositi open source softveru
Preduvjeti
Prije nego što počnete, provjerite je li Git instaliran. U terminal upišite:
git --version
Ako Git nije instaliran, preuzmite Git. Zatim postavite svoj lokalni Git profil u terminalu:
git config --global user.name "vaše-ime"
git config --global user.email "vaš-email"
Da biste provjerili je li Git već konfiguriran, možete upisati:
git config --list
Također će vam trebati GitHub račun, uređivač koda (poput Visual Studio Code-a) i otvoren terminal (ili: command prompt).
Idite na github.com i kreirajte račun ako već nemate, ili se prijavite i popunite svoj profil.
✅ GitHub nije jedini repozitorij za kod na svijetu; postoje i drugi, ali GitHub je najpoznatiji.
Priprema
Trebat će vam mapa s projektom koda na vašem lokalnom računalu (laptop ili PC) i javni repozitorij na GitHubu, koji će poslužiti kao primjer kako doprinositi projektima drugih.
Upravljanje kodom
Recimo da imate mapu lokalno s nekim projektom koda i želite početi pratiti svoj napredak koristeći git - sustav za kontrolu verzija. Neki ljudi uspoređuju korištenje gita s pisanjem ljubavnog pisma svom budućem ja. Čitajući svoje poruke o commitima danima, tjednima ili mjesecima kasnije, moći ćete se prisjetiti zašto ste donijeli neku odluku ili "vratiti" promjenu - pod uvjetom da pišete dobre "commit poruke".
Zadatak: Napravite repozitorij i commitajte kod
Pogledajte video
-
Kreirajte repozitorij na GitHubu. Na GitHub.com, u kartici repozitorija ili iz navigacijske trake u gornjem desnom kutu, pronađite gumb new repo.
- Dajte svom repozitoriju (mapi) ime.
- Odaberite create repository.
-
Navigirajte do svoje radne mape. U terminalu se prebacite na mapu (poznatu i kao direktorij) koju želite početi pratiti. Upišite:
cd [name of your folder]
-
Inicijalizirajte git repozitorij. U svom projektu upišite:
git init
-
Provjerite status. Da biste provjerili status svog repozitorija, upišite:
git status
Izlaz može izgledati otprilike ovako:
Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git checkout -- <file>..." to discard changes in working directory) modified: file.txt modified: file2.txt
Obično naredba
git status
govori stvari poput toga koji su fajlovi spremni za spremanje u repozitorij ili imaju promjene koje biste možda željeli zabilježiti. -
Dodajte sve fajlove za praćenje
Ovo se također naziva stavljanje fajlova u staging područje.git add .
Argument
git add
plus.
označava da su svi vaši fajlovi i promjene spremni za praćenje. -
Dodajte odabrane fajlove za praćenje
git add [file or folder name]
Ovo nam pomaže dodati samo odabrane fajlove u staging područje kada ne želimo commitati sve fajlove odjednom.
-
Uklonite sve fajlove iz staging područja
git reset
Ova naredba pomaže ukloniti sve fajlove iz staging područja odjednom.
-
Uklonite određeni fajl iz staging područja
git reset [file or folder name]
Ova naredba pomaže ukloniti samo određeni fajl iz staging područja koji ne želimo uključiti u sljedeći commit.
-
Spremanje vašeg rada. U ovom trenutku ste dodali fajlove u tzv. staging područje. Mjesto gdje Git prati vaše fajlove. Da biste promjenu učinili trajnom, trebate commitati fajlove. Da biste to učinili, kreirate commit pomoću naredbe
git commit
. Commit predstavlja točku spremanja u povijesti vašeg repozitorija. Upišite sljedeće za kreiranje commita:git commit -m "first commit"
Ovo commitira sve vaše fajlove, dodajući poruku "first commit". Za buduće commit poruke, želite biti detaljniji kako biste opisali kakvu ste promjenu napravili.
-
Povežite svoj lokalni Git repozitorij s GitHubom. Git repozitorij je koristan na vašem računalu, ali u nekom trenutku želite imati sigurnosnu kopiju svojih fajlova negdje i također pozvati druge ljude da rade s vama na vašem repozitoriju. Jedno od sjajnih mjesta za to je GitHub. Sjetite se da smo već kreirali repozitorij na GitHubu, tako da jedino što trebamo učiniti je povezati naš lokalni Git repozitorij s GitHubom. Naredba
git remote add
će to učiniti. Upišite sljedeću naredbu:Napomena: Prije nego što upišete naredbu, idite na stranicu svog GitHub repozitorija kako biste pronašli URL repozitorija. Koristit ćete ga u naredbi ispod. Zamijenite
https://github.com/username/repository_name.git
s vašim GitHub URL-om.git remote add origin https://github.com/username/repository_name.git
Ovo kreira remote, ili vezu, nazvanu "origin" koja pokazuje na GitHub repozitorij koji ste ranije kreirali.
-
Pošaljite lokalne fajlove na GitHub. Do sada ste kreirali vezu između lokalnog repozitorija i GitHub repozitorija. Pošaljimo ove fajlove na GitHub pomoću naredbe
git push
, ovako:Napomena: Vaša grana može imati drugačije ime od
main
.git push -u origin main
Ovo šalje vaše commitove u vašu "main" granu na GitHub.
-
Dodavanje dodatnih promjena. Ako želite nastaviti s promjenama i slati ih na GitHub, samo trebate koristiti sljedeće tri naredbe:
git add . git commit -m "type your commit message here" git push
Savjet: Možda ćete također htjeti usvojiti
.gitignore
fajl kako biste spriječili da se fajlovi koje ne želite pratiti pojavljuju na GitHubu - poput bilješki koje spremate u istoj mapi, ali nemaju mjesto u javnom repozitoriju. Možete pronaći predloške za.gitignore
fajlove na .gitignore templates.
Poruke commita
Odličan naslov Git commita završava sljedeću rečenicu: Ako se primijeni, ovaj commit će <vaš naslov ovdje>
Za naslov koristite imperativ, sadašnje vrijeme: "promijeni" umjesto "promijenio" ili "mijenja".
Kao i u naslovu, u tijelu (opcionalno) također koristite imperativ, sadašnje vrijeme. Tijelo bi trebalo uključivati motivaciju za promjenu i usporedbu s prethodnim ponašanjem. Objašnjavate zašto
, a ne kako
.
✅ Odvojite nekoliko minuta za istraživanje GitHuba. Možete li pronaći zaista dobru poruku commita? Možete li pronaći vrlo minimalnu? Koje informacije smatrate najvažnijima i najkorisnijima za prenošenje u poruci commita?
Zadatak: Suradnja
Glavni razlog za postavljanje stvari na GitHub bio je omogućiti suradnju s drugim programerima.
Rad na projektima s drugima
Pogledajte video
U svom repozitoriju, idite na Insights > Community
kako biste vidjeli kako se vaš projekt uspoređuje s preporučenim standardima zajednice.
Evo nekoliko stvari koje mogu poboljšati vaš GitHub repozitorij:
- Opis. Jeste li dodali opis za svoj projekt?
- README. Jeste li dodali README? GitHub pruža smjernice za pisanje README.
- Smjernice za doprinos. Ima li vaš projekt smjernice za doprinos?
- Kodeks ponašanja. Ima li vaš projekt Kodeks ponašanja?
- Licenca. Možda najvažnije, ima li vaš projekt licencu?
Svi ovi resursi koristit će za onboardanje novih članova tima. To su obično stvari koje novi suradnici prvo pogledaju prije nego što uopće pogledaju vaš kod, kako bi saznali je li vaš projekt pravo mjesto za njihovo ulaganje vremena.
✅ README fajlovi, iako zahtijevaju vrijeme za pripremu, često su zanemareni od strane zauzetih održavatelja. Možete li pronaći primjer posebno opisnog README-a? Napomena: postoje neki alati za pomoć pri kreiranju dobrih README-a koje biste mogli isprobati.
Zadatak: Spojite kod
Dokumentacija za doprinos pomaže ljudima da doprinesu projektu. Objašnjava koje vrste doprinosa tražite i kako proces funkcionira. Suradnici će morati proći kroz niz koraka kako bi mogli doprinositi vašem repozitoriju na GitHubu:
- Forkanje vašeg repozitorija. Vjerojatno ćete htjeti da ljudi forkaju vaš projekt. Forkanje znači kreiranje replike vašeg repozitorija na njihovom GitHub profilu.
- Kloniranje. Nakon toga će klonirati projekt na svoje lokalno računalo.
- Kreiranje grane. Zamolit ćete ih da kreiraju granu za svoj rad.
- Fokusiranje promjena na jedno područje. Zamolite suradnike da se koncentriraju na jednu stvar odjednom - na taj način su veće šanse da možete spojiti njihov rad. Zamislite da napišu ispravak greške, dodaju novu značajku i ažuriraju nekoliko testova - što ako želite ili možete implementirati samo 2 od 3, ili 1 od 3 promjene?
✅ Zamislite situaciju u kojoj su grane posebno ključne za pisanje i isporuku dobrog koda. Koje slučajeve upotrebe možete zamisliti?
Napomena: Budite promjena koju želite vidjeti u svijetu i kreirajte grane za svoj rad također. Svi commitovi koje napravite bit će napravljeni na grani na kojoj ste trenutno "prijavljeni". Koristite
git status
da vidite na kojoj ste grani.
Prođimo kroz tijek rada suradnika. Pretpostavimo da je suradnik već forkao i klonirao repozitorij tako da ima Git repozitorij spreman za rad na svom lokalnom računalu:
-
Kreiranje grane. Koristite naredbu
git branch
za kreiranje grane koja će sadržavati promjene koje žele doprinijeti:git branch [branch-name]
-
Prebacivanje na radnu granu. Prebacite se na određenu granu i ažurirajte radni direktorij pomoću
git switch
:git switch [branch-name]
-
Radite na promjenama. U ovom trenutku želite dodati svoje promjene. Ne zaboravite obavijestiti Git o tome pomoću sljedećih naredbi:
git add . git commit -m "my changes"
Osigurajte da svom commitu date dobro ime, za vaše dobro kao i za održavatelja repozitorija kojem pomažete.
-
Spojite svoj rad s
main
granom. U nekom trenutku završavate s radom i želite spojiti svoj rad s onim namain
grani.Main
grana se možda promijenila u međuvremenu, pa se prvo pobrinite da je ažurirate na najnoviju verziju pomoću sljedećih naredbi:git switch main git pull
U ovom trenutku želite osigurati da se svi sukobi, situacije u kojima Git ne može lako spojiti promjene, dogode u vašoj radnoj grani. Stoga pokrenite sljedeće naredbe:
git switch [branch_name] git merge main
Ovo će donijeti sve promjene iz
main
grane u vašu granu i, nadamo se, možete samo nastaviti. Ako ne, VS Code će vam pokazati gdje je Git zbunjen i samo izmijenite zahvaćene fajlove kako biste rekli koji je sadržaj najtočniji. -
Pošaljite svoj rad na GitHub. Slanje vašeg rada na GitHub znači dvije stvari. Pushing vaše grane na vaš repozitorij i zatim otvaranje PR-a, Pull Requesta.
git push --set-upstream origin [branch-name]
Gornja naredba kreira granu na vašem forkiranom repozitoriju.
-
Otvorite PR. Zatim želite otvoriti PR. To radite tako da odete na forkirani repozitorij na GitHubu. Vidjet ćete indikaciju na GitHubu gdje vas pita želite li kreirati novi PR, kliknite na to i bit ćete preusmjereni na sučelje gdje možete promijeniti naslov commit poruke, dati joj prikladniji opis. Sada će održavatelj repozitorija koji ste forkali vidjeti ovaj PR i držimo fige da će ga cijeniti i spojiti vaš PR. Sada ste suradnik, bravo :)
-
Očistite za sobom. Smatra se dobrom praksom očistiti nakon što uspješno spojite PR. Želite očistiti i svoju lokalnu granu i granu koju ste poslali na GitHub. Prvo je izbrišite lokalno pomoću sljedeće naredbe:
git branch -d [branch-name]
Osigurajte da odete na GitHub stranicu forkiranog repozitorija i uklonite udaljenu granu koju ste upravo poslali.
Pull request
možda zvuči kao čudan izraz jer zapravo želite "gurnuti" svoje promjene u projekt. No, održavatelj (vlasnik projekta) ili glavni tim treba razmotriti vaše promjene prije nego ih spoji s "glavnom" granom projekta, pa zapravo tražite odluku o promjeni od održavatelja.
Pull request je mjesto gdje možete usporediti i raspraviti razlike uvedene na grani uz recenzije, komentare, integrirane testove i još mnogo toga. Dobar pull request slijedi otprilike ista pravila kao i poruka commita. Možete dodati referencu na problem u trackeru problema, na primjer kada vaš rad rješava neki problem. To se radi pomoću #
praćenog brojem problema. Na primjer, #97
.
🤞Držimo fige da svi provjeri prođu i da vlasnik(i) projekta spoje vaše promjene u projekt🤞
Ažurirajte svoju trenutnu lokalnu radnu granu sa svim novim commitovima iz odgovarajuće udaljene grane na GitHubu:
git pull
Kako doprinijeti open source projektima
Prvo, pronađimo repozitorij (ili repo) na GitHubu koji vas zanima i kojem želite doprinijeti promjenom. Trebat ćete kopirati njegov sadržaj na svoje računalo.
✅ Dobar način za pronalazak repozitorija prilagođenih početnicima je pretraživanje prema oznaci 'good-first-issue'.
Postoji nekoliko načina za kopiranje koda. Jedan od načina je "kloniranje" sadržaja repozitorija pomoću HTTPS-a, SSH-a ili GitHub CLI-a (Command Line Interface).
Otvorite svoj terminal i klonirajte repozitorij ovako:
git clone https://github.com/ProjectURL
Za rad na projektu, prebacite se u odgovarajuću mapu:
cd ProjectURL
Također možete otvoriti cijeli projekt koristeći Codespaces, GitHub-ov ugrađeni uređivač koda / razvojno okruženje u oblaku, ili GitHub Desktop.
Na kraju, možete preuzeti kod u zipanoj mapi.
Još nekoliko zanimljivih stvari o GitHubu
Možete označiti zvjezdicom, pratiti i/ili "forkati" bilo koji javni repozitorij na GitHubu. Svoje označene repozitorije možete pronaći u padajućem izborniku u gornjem desnom kutu. To je poput označavanja stranica, ali za kod.
Projekti imaju tracker problema, uglavnom na GitHubu u kartici "Issues", osim ako nije drugačije naznačeno, gdje ljudi raspravljaju o problemima vezanim za projekt. Kartica Pull Requests je mjesto gdje ljudi raspravljaju i pregledavaju promjene koje su u tijeku.
Projekti također mogu imati rasprave na forumima, mailing listama ili kanalima za chat poput Slacka, Discorda ili IRC-a.
✅ Pogledajte svoj novi GitHub repo i isprobajte nekoliko stvari, poput uređivanja postavki, dodavanja informacija u svoj repo i stvaranja projekta (poput Kanban ploče). Puno toga možete učiniti!
🚀 Izazov
Udružite se s prijateljem kako biste radili na kodu jedno drugoga. Zajedno stvorite projekt, forkajte kod, kreirajte grane i spojite promjene.
Kviz nakon predavanja
Pregled i samostalno učenje
Pročitajte više o doprinosu open source softveru.
Vježbajte, vježbajte, vježbajte. GitHub ima odlične staze za učenje dostupne putem skills.github.com:
Također ćete pronaći naprednije tečajeve.
Zadatak
Završite tečaj Prvi tjedan na GitHubu
Odricanje od odgovornosti:
Ovaj dokument je preveden pomoću AI usluge za prevođenje Co-op Translator. Iako nastojimo osigurati točnost, imajte na umu da automatski prijevodi mogu sadržavati pogreške ili netočnosti. Izvorni dokument na izvornom jeziku treba smatrati autoritativnim izvorom. Za ključne informacije preporučuje se profesionalni prijevod od strane ljudskog prevoditelja. Ne preuzimamo odgovornost za bilo kakve nesporazume ili pogrešne interpretacije koje proizlaze iz korištenja ovog prijevoda.