Uitleg over GitHub

1. Introductie

Jorr.it werkt met GitHub. Broncode en documentatie dat voor u wordt gemaakt, wordt opgeslagen in een beveiligde GitHub repository. De repository houdt bij welke versies van de broncode hebben bestaan en welke wijzigingen hebben plaatsgevonden. Naast opslag van broncode kan GitHub ook goed gebruikt worden om de voortgang van een project te bewaken.

2. Issues, labels en milestones

Uw wensen worden in GitHub bijgehouden in issues. Vervolgens wordt bijgehouden welke bestanden en welke regels broncode zijn bewerkt om het issue c.q. uw wens te realiseren. Elke issue kan voorzien worden met labels om ze te organiseren: is het bijvoorbeeld een bug of juist een nieuwe wens door voorschrijdend inzicht. En elke issue kan gegroepeerd worden in milestones om zodoende aan te geven wat het uiteindelijke doel is.

3. Aanmelden

Om met u te kunnen samenwerken op GitHub, zult u zich aldaar eenmalig moeten aanmelden. Dat kan op de voorpagina van:

https://github.com

Als u zich hebt aangemeld, dan ontvang ik graag de gebruikersnaam die u hebt gekozen, zodat ik u deelgenoot kan maken van onze repository. Vervolgens wordt u middels een mail van GitHub uitgenodigd om lid te worden van de repository "jorr-it/[uwproject]". Als u dat hebt geaccepteerd is de aanmelding compleet.

4. Broncode

Als eenmaal bent aangemeld en ingelogd op GitHub, dan hebt u toegang tot alle delen van de repository. U kunt de broncode inzien en downloaden. U kunt ook lezen en schrijven in de wiki van het project. En u kunt issues aanmaken en bewerken. Dit en meer is te vinden in uw repository te vinden op dit adres:

https://github.com/jorr-it/[uwproject]

5. Projectbord

Zodra we zijn gestart met het project, worden de verschillende taken aangemaakt als issues in GitHub. Als we vooraf een functioneel ontwerp hebben gemaakt, dan komen de issues overeen met de onderdelen uit dat ontwerp. Elke issue doorgaat een reeks aan fases, bijvoorbeeld To do, In progress, Test en Done. De issues en de fases zijn te organiseren op een projectbord (ook wel kanban of scrumboard genoemd). Het projectbord van uw project is:

https://github.com/jorr-it/[uwproject]/projects/1

6. Issue aanmaken

Als u een wens kenbaar wilt maken of een bug hebt gevonden, dan kunt u een issue aanmaken. Het aanmaken van een issue gaat in twee stappen:
a) Met het plus-teken boven de kolom To do maakt u eerst een card aan. Geef de card een korte omschrijving.
b) Vervolgens kunt u de card converteren naar een issue. Hiervoor gebruikt u het kleine menuknopje met de drie stipjes, rechtboven de card.

Een andere manier om issues aan te maken is via tabblad Issues. Maar let op, issues aangemaakt via deze lijst komen niet (automatisch) op het projectbord.

7. Reageren op een issue

U kunt de issues slepen van kolom naar kolom. Zodra u klikt op de titel van een issue, dan krijgt u rechts in het scherm allerlei details te zien. Klik op de knop met titel "Go to issue for full details". Dan krijgt u nog meer details van het issue te zien, bijvoorbeeld mijn broncode die bij het issue hoort. Onderaan heeft u de mogelijkheid om een bericht achter te laten. Dit kunnen bijvoorbeeld uw testbevindingen zijn. U kunt een bericht aan iemand adresseren door een @-teken te gebruiken. Bijvoorbeeld "Hallo @jorr-it, dank voor het geleverde werk".

8. Issue sluiten

Zodra een issue volledig gereed is, dan kunnen we het sluiten. Zodra u klikt op de titel van een issue, dan krijgt u rechts in het scherm allerlei details te zien. Klik op de knop met titel "Close issue". Vervolgens schuift de card automatisch naar de kolom Done.

© 2020 Jorrit Steetskamp