🌊GitFlow

• Commits: When commiting to a feature/bugfix/setup/implement branch, give the commit a short, but clear title on what has been done on that branch like in the example below. The description needs to contain a more detailed explanation of what has been done on that branch. To indicate what has been done with the files on a branch you write down what files have been: Changed, Added, Removed, Fixed. Like in the example down below. For a model branch, the title needs to include ModelName+Version_Type_Date like in the example below. The description needs to contain who made it and then a what files have been included.

• Example Commit feature/bugfix/setup/implement/refactor branch:

  • Title: Movement bugfixes.
  • Description: Fixed: bug on when player moves with leftStick the player jumps, now just moves to the left. Changed: Movement.CS

• Example Commit model branch:

  • Title: Robot001_Mesh_21/03/2024.
  • Description: Made by: Sjaakie. Files included: 1 robot model, 1 robot texture, 1 robot material, 1 robot prefab

• Pull Requests: When creating a Pull Request you need to select the Develop branch to merge into from your own feature/model/bugfix/setup/implement branch. The title of the Pull Request needs to contain PullRequest + the name of your current branch. In the description you need to indicate from which branch you're merging from and merging to. When the Pull Request is made, notify one of the leads and ask for a review. When a Pull Request is send back by the leads. The given feedback needs to be applied. When the given feedback is applied, the Pull Request needs to be updated and checked again by the leads.

• Example Pull Request:

  • Title: PullRequest feature/movement
  • Description: Merging feature/movement into develop.

• Branches: For creating branches you need to use a prefix for the branch name. In the naming of branches we use no capital letters. For every bugfix/feature/model/setup/implement/refactor you need to create a new branch. Never commit directlty into develop/master/main, Except for changes to the ReadMe. mostly regarding main branch. If you want to change something create a Pull Request. At the end of every sprint we merge develop into master. When bugs occur when testing features on develop, a new bugfix branch has to created to fix said bugs.

• Special Branches:

  • Develop The branch we merge our changes into and test features with other features.
  • Master The branch holding the most recent Minimal Viable Product (MVP).
  • Main The branch holding the documentation and is the landing page/branch for any user.

• Branch Naming:

  • feature/(feature name)
  • model/(model name)
  • bugfix/(what you are fixing)
  • setup/(what you are setting up)
  • implement/(what you are implementing)
  • refactor/(what you are refactoring)

• What Lead Developer/Artist check for:
  When checking a pull request the leads check if the conventions are correctly applied. If conventions aren't correctly appplied the leads sent the pull request back with feedback in the Pull Request via comments or description.