Onder issues kan je terugvinden wat er uitgewerkt moet worden. Je kan er ook zien aan welke issues er gewerkt (zie assigned) en besproken (zie spreekballon) worden.
Je kan ook altijd nieuwe issues aanmaken. Bespreek het probleem of de feature uitvoerig en geef aan waarom je deze issue nodig acht.
Eenmaal er in onderling overleg (inclusief de docent) besloten is dat de issue dient uitgevoerd te worden kan er een branch aangemaakt worden.
Een branch zorgt ervoor dat je veilig kan testen zonder de structuur en inhoud van de repo overhoop te gooien voor anderen. Het kan namelijk zijn dat je verscheidene commits hebt moeten doen om één bepaalde README.md te updaten of verscheidenen programma's geschreven hebt vooraleer je tot het uiteindelijke programma komt. Op deze manier stoor je anderen niet met alle tijdelijke veranderingen vooraleer je tot het resultaat van de issue komt.
Best maak je de branch pas aan zodra je aan de issue gaat werken. Zo voorkom je een wildgroei van branches, maar ook dat anderen verkeerdelijk denken dat er reeds aan de issue gewerkt word.
Eenmaal er enkele commits in de branch bestaan kan een pull request (PR) aangemaakt worden.
Binnen de PR kan je bespreken als de wijzigingen voldoende zijn om de issue te sluiten, alsook afgestemd is aan de inhoud waarmee het gaat mergen (meestal de master). Je wil immers niet dat er elementen of de structuur uit bv. de master verloren gaan.
Bijkomend zorgt het openen van een branch vanuit de issue er eveneens voor dat het sluiten van de PR eveneens de issue sluit. Dat is gemakkelijk.
- Binnen een Pull Request kun je vragen stellen, verzoeken indienen of informatie toevoegen, of om een review aan te vragen.
- Een teamlid zal de PR reviewen en mogelijk vragen stellen of extra informatie verzoeken. Er kan gevraagd worden om wijzigingen aan te brengen voordat een PR kan worden gemerged.
- De docent zal de informatie bekijken en de PR sluiten als deze voltooid is. Om de aandacht van de docent te trekken, gebruik @mention.
- Bij het openen van een issue, overweeg om de titel te beginnen met het label van de oplossing waaraan je bijdraagt (bijv. [TwinCAT] of [VISION]). De meeste oplossingsnamen kunnen worden gevonden als mappen binnen de hoofdmap.
- Alle problemen kunnen best worden gekoppeld aan het GitHub project "Professional Skills."
