College Deanna Bosschert

Bij het college van Deanna kregen we uitleg over GitHub. Ze begon met de uileg over de inrichting van de Repository. Dit zijn de onderdelen welk gebruikelijk zijn om mee te nemen in de repo:

• Code comments: Zo veel mogelijk commenten bij de geschreven code. Hierdoor weten anderen waar de code over gaat, en is het handiger voor jezelf als je de code moet uitleggen.

• Commits: Hoe vaker hoe beter. Als er iets fout gaat kunnen de commits teruggezet worden. Ook hier geldt: hoe meer hoe beter.

• Branches: Door branches worden er aftakkingen gemaakt in het project. Hierdoor kunnen nieuwe functies veilig gemerged worden met de main branch en hierdoor is het veel praktischer om met andere developers samen te werken.

• Pull Requests: Met pull requests kunnen andere developers de code van een nieuwe branch controleren voordat deze branch gemerged wordt met de main branch. Ook is het hierdoor makkelijk te zien of er merge conflicts zijn met de main branch.

• Project Board: Het project board dient als het ware als een Trello bord. Alle taken van het project kunnen hierin gezet worden waardoor alle taken overzichtelijk zijn weergegeven in het project zelf.

• Issues: Issues kunnen dienen als to-do list, maar ook als opmerkingen/aanmerkingen van andere developers die feedback geven op het project. De issues kunnen gecategoriseerd worden door middel van labels.

• Readme: De readme wordt gebruikt als een korte uitleg over het project. Hierin staat meestal wat het project is en hoe het lokaal kan worden geinstalleerd en gebruikt. Ook is het veelvoorkomend om een to-do list erin te zetten met bijkomende functies.

• Wiki: In de wiki staat alle documentatie van het project. Er kan een uitgebreid concept van het project in staan, een logboek met de gemaakte keuze's en onderbouwing en notities met bijvoorbeeld feedback. Het is aan te raden om zo veel mogelijk documentatie te noteren en te bewaren, zo is het voor jezelf en voor anderen zo overzichtelijk mogelijk.