diff --git a/documentatie/GitHub werkwijze.md b/documentatie/GitHub werkwijze.md index 650046a1a..4e5f70452 100644 --- a/documentatie/GitHub werkwijze.md +++ b/documentatie/GitHub werkwijze.md @@ -1,11 +1,14 @@ # GitHub werkwijze -Dit document beschrijft de werkwijze met Github. Er zijn meerdere manieren om deze stappen te zetten. +Dit document beschrijft de werkwijze met GitHub. +Er zijn meerdere manieren om deze stappen te zetten. - Pak een issue op uit de 'Current'-kolom van het bord: - Bekijk de bijbehorende epic voor context over dit issue. - - Controleer of alle randvoorwaarden zijn voltooid. Als er een randvoorwaarde mist en er nog geen issue voor is, - overleg dan met het team. + - Controleer of alle randvoorwaarden zijn voltooid. Als er een randvoorwaarde + mist en er nog geen issue voor is, overleg dan met het team. + - Wijs jezelf toe aan het issue + - Zet het issue op 'In progress' onder 'Projects' in de rechterkolom van het issue. - Bedenk of het issue duidelijk genoeg is om te implementeren. Zijn er architectuur-overwegingen die afgestemd moeten worden? Betrek bij twijfel het team voordat je code gaat schrijven. @@ -18,23 +21,28 @@ Dit document beschrijft de werkwijze met Github. Er zijn meerdere manieren om de - Schrijf de code: - Implementeer de functionaliteit die wordt beschreven in het issue. - - Maak testen aan voor de functionaliteit en voer ze uit. + - Test de functionaliteit, schrijf zover zinvol tests (unit, integration etc). + - Push ook tussentijdse commits naar GitHub. + - Dit project gebruikt [Lefthook] om de Git pre-commit hook te beheren. Lefthook zal + automatisch geïnstalleerd worden wanneer `npm install` wordt uitgevoerd in de `frontend` + directory. -- Maak een pull request aan: +- Maak een pull request (PR) aan: - Als de branch commits bevat die al eerder gemerged zijn, kun je die verwijderen met een _interactive rebase_: `git fetch; git rebase origin/main --interactive` en verwijder de betreffende commits uit de lijst. - - Verwijs naar het issue in een comment, bijv. `Closes #42` + - Verwijs naar het issue in de beschrijving, bijv. `Closes #42`, + of link het issue aan de PR onder 'Development' in de rechterkolom. - Wijs ten minste 2 reviewers aan. + - Een [draft pull request] maken is mogelijk ook als je nog niet klaar bent, maar wel feedback wilt. + Geef in dat geval duidelijk aan (bijv. in de description of een comment) waarop je feedback wilt + en wat er nog moet gebeuren om de pull request af te maken. - Merge de pull request: - - Zorg dat de branch up to date is met main - Zorg dat alle opmerkingen (conversations) opgelost zijn. - - Zorg dat je 2 approvals hebt - - Consolideer de merge message; behoud alleen de belangrijkste punten - - Sluit de pull request met *Squash and Merge*. - -Dit project gebruikt [Lefthook] om de Git pre-commit hook te beheren. Lefthook zal -automatisch geïnstalleerd worden wanneer `npm install` wordt uitgevoerd in de `frontend` -directory. + - Zorg dat je 2 approvals hebt. + - Zorg dat alle checks slagen. + - Klik op 'Merge when ready' om te mergen via de [merge queue]. +[draft pull request]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests [Lefthook]: https://github.com/evilmartians/lefthook +[merge queue]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue