Skip to content
This repository has been archived by the owner on Apr 21, 2021. It is now read-only.

Git branching system used

Jump to bottom
ultimathei edited this page Oct 25, 2020 · 7 revisions

NOTE: I thought we should use a defined system of how we implement new feature additions to the project. The steps I've come up with is a simple git-flow and has three stages:

master branch

This branch will have the latest working version of the code. Only code modifications that have been reviewed by others should be merged into this branch to avoid breaking the code.

develop branch

This branch will be our common place to test out features and additions that we believe are working. You can merge your code from one of the feature branhces into this one once you are confident that your code works on that branch. Once merged, test it on the develop branch, make sure nothing was broken due to the new feature. Then create a pull-request for your change (marking that you would like this to be reviewed by the other two devs) and assign the other to devs as reviewers. They then should review that it indeed works on their side too and approve the change. At that point it is safe to merge into master.

feature/... branches

We should create a new feature branch for each new feature or addition we would like to add. Only do work on the feature branches. The other two branhces are only for marging these features together.

Example of the process:

You have a new feature that you'd like to add to the project, let's say it is a jump ability to the main character.

  1. checkout the develop branch
  2. pull the latest version of that branch so you start with the most up to date version
  3. create a new branch from this branch and name it to specific to the new feature:

git checkout -b feature/character_jump

  1. this will create the new branch locally, so now you have to make a push to the remote branch. In VSCode I just select 'push' and it will ask me if i want to publish an upstream branch for this local branch. Select yes. Now your branch is published on github too.

alternatively you can type the following command (will do the same):

git push --set-upstream origin feature/charcter_jump

  1. start making additions/modifications to the project
  2. once you have tested locally and happy with the code you should push to the remote branch, so we have a copy of these changes in the repo.
  3. then you should merge this feature branch into the develop branch as follows:
  1. checkout the develop branch and pull the latest version
  2. type the following command to merge your feature branch into develop

git merge feature/character_jump

  1. test the code again locally
  1. If the changes didn't break anything, push the changes of the develop branch to the repo
  2. Go the the github repo's part in a browser. There will be a yellow box at the top saying you have recently pushed changes to develop branch. Click the button 'Create pull request'. This will take you to the pull request page. Select the master branch at the top (you want to merge changes to master). Then add any comments needed and select the reviewers (other two devs) and click Save.
  3. The other two devs will review and approve your changes and merge into master.
  4. the master branch finnally will have your feature
Clone this wiki locally