Github Workflow - ZuydUniversity/B2C6_B2A_Backend GitHub Wiki

GitHub workflow

The GitHub workflow. Starts with creating a branch, committing changes, creating a pull request for review and finally merging back into the main branch.

Rob Cilissen heeft een handige playlist gemaakt voor het gebruiken van Github & Visual Studio: https://youtube.com/playlist?list=PLV3-439d8HgApfmaIgF_jees3k1p2n7iB&feature=shared

Hieronder heb ik een korte summary geschreven over het gebruik van Github en Visual Studio of VS Code.

Visual Studio

Clone repository

  1. Open Visual Studio
  2. Klik op Clone a repository
  3. Vul je repository URL in of klik op Browse a repository; GitHub
  4. Selecteer de GitHub repository die je wilt clonen

New Branch via GitHub Issue

  1. Op GitHub selecteer de issue uit sprintboard/backlog
  2. Open in new tab
  3. Aan de rechterkant, klik op Create a branch for this issue
  4. In Visual Studio, ga naar het tabblad Git Changes (Indien je deze nog niet hebt, selecteer hem bij View => Git Changes)
  5. Klik op fetch, de dotted pijl naar beneden
  6. Klik op main rechtsonder
  7. Selecteer de juiste remote branch

Commiting changes

  1. Klik rechtsonder op het tabblad Git Changes
  2. Geef een duidelijke naam aan deze commit, beschrijf kort wat je gedaan hebt.
  3. Druk op Commit All

Pushing Changes

  1. In Git Changes, klik op push, het pijltje dat omhoog wijst
  2. Je commits zijn nu gepushed naar de remote branch op Github

Solving conflicts

Pull Request maken

  1. Op Github selecteer jouw branch
  2. Selecteer Compare & pull request of Selecteer Contribute => Open pull request
  3. Indien hij able to merge is, selecteer Create pull request
  4. (Klik op Reviewers aan de rechterkant van de pagina en voeg iemand uit je team toe om je code te reviewen)

Pull Request goedkeuren en mergen

  1. Selecteer de Pull request
  2. Controleer eventueel handmatig de code
  3. Indien er geen conflicten zijn klik op Merge pull request
  4. Wanneer deze branch gekoppeld is aan een user story/issue dan wordt deze userstory gesloten en op Done gezet
VS Code

Clone repository

  1. Open VSCode in een new window
  2. Klik op Clone Git Repository
  3. Klik op Clone from Github
  4. Log eventueel in op je Github account
  5. Selecteer de github repository die je wilt clonen of plak de link van de repository
  6. Selecteer een plek om de repository lokaal op te slaan

New Branch via Github Issue

  1. Op github selecteer de issue uit sprintboard/backlog
  2. Open in new tab
  3. Aan de rechterkant, klik op Create a branch for this issue
  4. In VS Code klik op main linksonder
  5. Selecteer de juiste branch

Commiting changes

  1. Sla alle veranderingen in alle documenten op (anders ziet Git ze niet)
  2. Klik links op het icoon van Source Control
  3. Geef een duidelijke naam aan deze commit, beschrijf kort wat je gedaan hebt
  4. Druk op Commit
  5. Op dit moment is je Commit lokaal opgeslagen (Nog niet op Github)

Pushing changes

  1. Klik op Sync Changes
  2. Je commits zijn nu gepushed naar de remote branch op Github

Solving Conflicts

Pull Request maken

  1. Wanneer je user story/feature af is, dan maak je een pull request om je feature branch naar de main branch te zetten
  2. Op Github, selecteer jouw branch
  3. Selecteer Compare & pull request of selecteer Contribute => Open pull request
  4. Indien hij Able to merge is, selecteer Create pull request
  5. (Klik op Reviewers aan de rechterkant van de pagina en voeg iemand uit je team toe om je code te reviewen)

Pull Request goedkeuren en mergen

  1. Selecteer de Pull request
  2. Controleer eventueel handmatig de code
  3. Indien er geen conflicten zijn klik op Merge pull request
  4. Wanneer deze branch gekoppeld is aan een user story/issue dan wordt deze gesloten en op Done gezet
⚠️ **GitHub.com Fallback** ⚠️