GitHubin käyttö – ensimmäiset askeleet selkeästi

GitHubin käytön aloittaminen voi tuntua vaikealta, jos palvelu avautuu ensimmäistä kertaa eteesi. Näytöllä näkyy tiedostoja, välilehtiä ja englanninkielisiä käsitteitä, joiden merkitystä ei vielä tunne. Mistä pitäisi aloittaa, ja mitä kaikkea täytyy osata etukäteen?

Ensimmäisiin harjoituksiin tarvitset vain verkkoselaimen, GitHub-tilin ja pienen hetken aikaa. Ohjelmointitaitoa tai komentorivin tuntemusta ei tarvita. Voit opetella perustoiminnot tavallisella tekstitiedostolla ja siirtyä varsinaisiin ohjelmistoprojekteihin myöhemmin.

Tässä oppaassa luot oman harjoitusprojektin, muokkaat sen sisältöä ja kokeilet muutosten yhdistämistä. Samalla opit, mitä GitHubin tärkeimmät painikkeet ja käsitteet tarkoittavat käytännössä.

Ymmärrä ensin, mitä olet tekemässä

GitHubissa työskentely rakentuu projektien ympärille. Projektin tiedostot ja niiden muutoshistoria muodostavat repositorion eli repositoryn. Sitä voi ajatella projektikansiona, joka muistaa tallennetut muutokset.

Tavallisessa kansiossa saatat korvata vanhan tiedoston uudella. Versionhallinnassa voit tarkastella, mitä sisältöön muutettiin ja milloin. Tämä auttaa ymmärtämään työn etenemistä ja selvittämään myöhemmin huomattuja virheitä.

Tässä harjoituksessa rakennat pienen oppimismuistion. Sen avulla kokeilet samoja perustoimintoja, joita käytetään suuremmissakin projekteissa.

Harjoituksen aikana:

• Luot oman repositorion.
• Kirjoitat projektin esittelytekstin.
• Tallennat muutoksia historiaan.
• Kokeilet työskentelyä erillisessä haarassa.
• Yhdistät valmiin muutoksen päähaaraan.

GitHubin perustoimintoihin voi tutustua kokonaan selaimessa. Myös GitHubin virallinen aloitusharjoitus perustuu tähän lähestymistapaan.

Luo käyttäjätili ja valitse sopiva käyttäjänimi

Aloita avaamalla GitHub ja luomalla käyttäjätili. Seuraa rekisteröitymisen ohjeita ja vahvista sähköpostiosoitteesi palvelun pyytämällä tavalla.

Valitse käyttäjänimi, jota voit käyttää myös myöhemmin. Jos aiot jakaa omia projektejasi muille, helposti muistettava nimi helpottaa profiilisi löytämistä.

Profiilin kuvausta ei tarvitse viimeistellä heti. Aluksi tärkeintä on päästä harjoittelemaan. Voit täydentää esittelyäsi, profiilikuvaasi ja muita tietoja sen jälkeen, kun palvelu on tullut tutummaksi.

Mieti kuitenkin jo alussa, millaisen vaikutelman haluat antaa. Harrastusprojekteissa nimimerkki voi toimia hyvin. Ammatillisessa käytössä tunnistettava nimi saattaa olla luontevampi valinta.

Kirjoita halutessasi lyhyt kuvaus kiinnostuksenkohteistasi. Esimerkiksi ”Opettelen verkkosivujen tekemistä ja kokoan tänne harjoituksiani” kertoo vierailijalle riittävästi ilman pitkää esittelyä.

Perusta ensimmäinen repositorio

Kirjautumisen jälkeen etsi uuden repositorion luomiseen tarkoitettu New repository -toiminto. Avautuvassa näkymässä määrität projektin perustiedot.

Anna repositoriolle nimi, esimerkiksi oppimismuistio. Lyhyt ja kuvaava nimi on helpompi tunnistaa kuin satunnainen kirjainyhdistelmä.

Täytä tiedot seuraavasti:

1. Kirjoita Repository name -kenttään projektin nimi.
2. Lisää Description-kenttään lyhyt kuvaus.
3. Valitse näkyvyydeksi Public tai Private.
4. Valitse README-tiedoston lisääminen.
5. Paina Create repository.

Kuvaukseksi sopii esimerkiksi ”Muistiinpanoja GitHubin käytön harjoittelusta”.

Public tarkoittaa julkista repositoriota. Private tarkoittaa yksityistä repositoriota, jonka käyttöoikeudet ovat rajattuja. Ensimmäisen harjoituksen voi hyvin tehdä yksityisenä, jos et halua jakaa keskeneräistä sisältöä.

GitHub Free mahdollistaa sekä julkisten että yksityisten repositorioiden luomisen. Pakettien ominaisuuksissa on eroja, mutta tavalliseen aloitusharjoitteluun ilmainen vaihtoehto riittää yleensä. Tarkemmat tiedot löytyvät GitHubin palvelupakettien kuvauksesta.

Tutustu projektin näkymään rauhassa

Kun repositorio on luotu, näet sen oman sivun. Ensimmäisellä kerralla kannattaa keskittyä tiedostoluetteloon ja sen alapuolella näkyvään esittelyyn.

README.md on projektin esittelytiedosto. Sen sisältö näytetään repositorion etusivulla, joten se on luonteva paikka kertoa projektin tarkoituksesta.

Muita myöhemmin hyödyllisiä kohtia ovat:

• Code, jossa tarkastelet projektin tiedostoja.
• Issues, jossa seurataan esimerkiksi tehtäviä ja ongelmia.
• Pull requests, jossa käsitellään muutosehdotuksia.
• Settings, jossa hallitaan repositorion asetuksia.

Kaikkiin välilehtiin ei tarvitse tutustua heti. Avaa ensin README.md ja katso, miltä yksittäinen tiedosto näyttää.

Tavoitteena on hahmottaa yksinkertainen yhteys: repositorio sisältää tiedostoja, ja README on yksi niistä. Sen näkyminen myös etusivulla tekee siitä erityisen hyödyllisen aloituskohdan.

Muokkaa README-tiedostoa ensimmäisen kerran

Avaa README.md ja valitse tiedoston muokkaustoiminto. Kirjoita esittelyyn muutama lause omin sanoin.

Voit kertoa esimerkiksi:

• Miksi loit tämän projektin.
• Mitä haluat oppia.
• Mitä olet jo kokeillut.
• Mikä on seuraava harjoituksesi.

Ensimmäinen teksti voisi olla: ”Tämä on oma GitHub-harjoitukseni. Opettelen tiedostojen muokkaamista, muutosten tallentamista ja haarojen käyttöä.”

README-tiedostoissa käytetään tavallisesti Markdown-muotoilua. Sen avulla tekstiin voi lisätä otsikoita ja luetteloita yksinkertaisilla merkeillä. Tässä vaiheessa pelkkä tavallinen teksti riittää kuitenkin hyvin. README-tiedostojen tarkoituksesta kerrotaan GitHubin aloitusohjeessa.

Pidä ensimmäinen muokkaus pienenä. Yhden kappaleen muuttaminen auttaa näkemään selvästi, mitä tallennuksessa tapahtuu.

Tallenna muutos kuvaavalla viestillä

Kun teksti on valmis, valitse Commit changes. Commit tarkoittaa projektin historiaan tallennettavaa muutoskokonaisuutta.

Tallennuksen yhteydessä kirjoitetaan viesti, joka kertoo muutoksen sisällöstä. Hyvä viesti auttaa myöhemmin ymmärtämään projektin vaiheita avaamatta jokaista tiedostoa erikseen.

Ensimmäiseen muutokseen sopii esimerkiksi:

• Lisää oppimismuistion esittely.
• Kirjaa harjoituksen tavoitteet.
• Täydennä projektin kuvausta.

Vältä viestejä, kuten ”jotain” tai ”muutoksia”. Ne eivät kerro, miksi tallennus tehtiin.

Jos tallennusnäkymä tarjoaa vaihtoehdoksi muutoksen tekemistä suoraan nykyiseen haaraan, voit käyttää sitä tässä omassa harjoituksessa.

Tallennettuasi avaa tiedosto uudelleen ja tarkista sisältö. Tee sitten pieni korjaus ja tallenna se uudella viestillä. Näin huomaat, että projekti etenee erillisinä, nimettyinä muutoksina. Commitien roolia selittää GitHubin Git-opas.

Harjoittele muutoksia omassa haarassa

Seuraavaksi kokeile haaraa eli branchia. Haara antaa mahdollisuuden valmistella muutoksia erillään päähaarasta.

Repositorion päähaaran nimi on usein main. Luo siitä uusi haara tiedostoluettelon yläpuolella olevasta haaravalikosta. Anna nimeksi esimerkiksi lisaa-tavoitteet.

Tarkista tämän jälkeen, että valikossa näkyy uuden haaran nimi. Muokkaa README-tiedostoa ja lisää siihen kolme konkreettista tavoitetta:

• Osaan tehdä kuvaavan tallennusviestin.
• Ymmärrän päähaaran ja työhaaran eron.
• Osaan tarkistaa muutoksen ennen yhdistämistä.

Tallenna muutos tähän haaraan.

Vaihda sitten hetkeksi takaisin main-haaraan. Äsken lisäämäsi tavoitteet eivät vielä näy siellä. Tämä havainnollistaa haarojen tarkoituksen: voit valmistella uutta sisältöä muuttamatta heti päähaaran versiota. Haarautumista käsitellään GitHubin versionhallinnan esittelyssä.

Avaa muutosehdotus ja tarkista sisältö

Kun työhaarasi muutos on valmis, avaa Pull requests -välilehti ja valitse New pull request.

Valitse vertailun kohteeksi main ja muutokset sisältäväksi haaraksi lisaa-tavoitteet. Tarkista valinnat huolellisesti, jotta olet ehdottamassa muutosta oikeaan suuntaan.

Anna ehdotukselle otsikko, kuten ”Lisää oppimistavoitteet esittelyyn”. Kirjoita kuvaukseen lyhyesti, mitä lisäsit ja miksi.

Tarkastele tämän jälkeen tiedostojen eroja:

• Näkyvätkö kaikki tarkoittamasi lisäykset?
• Poistuiko tekstiä vahingossa?
• Onko mukana kirjoitusvirheitä?
• Vastaako muutos otsikkoa ja kuvausta?

Pull request toimii paikkana muutoksen tarkastelulle ja keskustelulle. Omassa harjoitusprojektissa voit käydä tarkistuksen läpi itse. Yhteisessä projektissa toinen osallistuja voi kommentoida ehdotusta ennen yhdistämistä. Työnkulku kuvataan GitHubin Git-oppaassa.

Yhdistä valmis muutos päähaaraan

Kun olet tyytyväinen ehdotukseen, yhdistä se Merge pull request -toiminnolla ja vahvista yhdistäminen.

Palaa Code-välilehdelle ja valitse main-haara. Oppimistavoitteiden pitäisi nyt näkyä README-tiedostossa myös siellä.

Olet suorittanut kokonaisen työkierron: loit haaran, muokkasit sisältöä, tallensit muutoksen, tarkistit ehdotuksen ja yhdistit sen.

Jos GitHub ilmoittaa yhdistämisristiriidasta, pysähdy selvittämään, mitä samoihin kohtiin on muutettu. Ristiriita tarkoittaa, ettei sisältöjä voida yhdistää sellaisenaan automaattisesti. Tässä pienessä harjoituksessa ristiriitaa ei yleensä synny, jos päähaaraa ei ole muutettu välissä.

Ota seuraavaksi käyttöön yksinkertainen tehtävälista

Kun ensimmäinen muutos onnistuu, kirjaa seuraavat harjoitukset Issues-osioon. Yksi tehtävä yhdessä issuessa pitää tekemisen selkeänä.

Sopivia harjoitustehtäviä ovat:

• Täydennä projektin esittelyä.
• Korjaa yksi epäselvä lause.
• Lisää yhteenveto opituista asioista.

GitHub Issues soveltuu tehtävien, ideoiden ja ongelmien seurantaan, kuten palvelun ohjeessa kerrotaan.

Toista sama pieni työnkulku muutaman kerran. Kun tallennukset, haarat ja muutosehdotukset tulevat tutuiksi, voit keskittyä oman projektisi sisältöön. Perusasioiden hallinta syntyy tekemisestä, eikä ensimmäisen harjoituksen tarvitse olla täydellinen.