Koden ligger på GitHub, og den virker. Likevel må du forklare en ny kollega hvordan prosjektet startes, mappen node_modules er lastet opp med tusenvis av filer, og oppgavelisten ligger i et regneark ingen oppdaterer. GitHub har verktøy for alle tre, og de fleste er en fil eller en fane unna.
Hold rot og hemmeligheter ute med .gitignore
Ikke alt i prosjektmappen hører hjemme i Git. Avhengigheter som node_modules kan lastes ned på nytt når som helst, byggefiler lages av koden, og en .env-fil med passord og API-nøkler skal aldri forlate maskinen din. I filen .gitignore lister du opp det Git skal late som ikke finnes.
Når du lager et nytt repo på GitHub, kan du velge en ferdig .gitignore-mal for språket eller rammeverket ditt. Malen for Node dekker det meste et React-prosjekt trenger, og er et bedre utgangspunkt enn en tom fil. Legg den inn før første commit. Det er mye enklere å holde noe ute fra starten enn å fjerne det fra historikken etterpå.
Obs: .gitignore virker bare på filer Git ikke allerede følger med på. Har en fil først blitt committet, må den tas ut av sporingen før regelen gjelder.
Forklar prosjektet med en README
README.md er det første besøkende ser når de åpner et repo. GitHub viser den automatisk under fillisten. Den bør svare på tre ting: hva prosjektet er, hvordan man installerer det, og hvordan man starter det. Filen skrives i Markdown, der en linje som begynner med # blir en overskrift og tekst mellom tre backticks blir en kodeblokk.
Når du lurer på hvordan et prosjekt på GitHub fungerer, er det README-en du scroller ned til. Lag den for dine egne prosjekter med samme tanke, også når det bare er deg som skal lese den om et år.
Planlegg arbeidet med Issues
Fanen Issues er en oppgaveliste inne i repoet. Hver oppgave får tittel, beskrivelse, en ansvarlig og etiketter som bug eller enhancement, og et nummer. Nevner du nummeret i en commit-melding, for eksempel «Startet på header #2», vises commiten i issuet. Skriver du «close #2», lukkes issuet automatisk når commiten pushes.
Issues er også et sted å be om hjelp. Du kan kommentere underveis og tagge en kollega som kan akkurat det du står fast på, slik at diskusjonen ligger samlet med oppgaven.
Få oversikt med GitHub Projects
Projects samler issues på en tavle i Kanban-stil med kolonner som Backlog, Ready, In progress, In review og Done. Du kan importere issuene du allerede har, og flytte dem mellom kolonnene etter hvert som arbeidet går. Prosjektlederen ser hvem som jobber med hva uten å spørre, og en pull request som blir slått sammen, kan flytte oppgaven sin til Done av seg selv.
Fra artikler til nettkurs
Artiklene her er hentet fra kurset Git og GitHub på Utdannet.no. Der lager du .gitignore og README for et ekte prosjekt, oppretter issues med etiketter, kobler commits til dem og setter opp en tavle i GitHub Projects. Kurset viser også versjonskontrollen i Visual Studio Code, GitHub CLI for deg som vil styre GitHub fra terminalen, og hvor du begynner med GitHub Actions når du vil automatisere testing og publisering.
