Git workflow conventions

This document outlines rules that each member of the team should abide by to provide a smooth development experience for everyone

Gitflow structure:

We will be working with CI/CD workflow where we will try to test our project as a whole as much as possible. the plan is to have rapid development workflow and a pipeline for automated build processing. the idea is to have the pipeline build for 3 platforms when a push is made to the master branch: IOS, Android and Windows.

We will have a master branch where we will have major releases pushed to We will have a develop branch where we will work on constantly.

seperate temporary branches will be made and deleted once no longer used.

Branch naming convention:

When creating a new feature a branch is needed to make since we dont want to apply changes to development directly. this branch will have the prefix of feature/ to indicate that this is a feature

When needing to modify something on the dev branch there should be a seperate hotfix branch on the requested change with the prefix hotfix/

When adding a new asset related to Art the branch should be created with the prefix art/

When a asset needs some modifcation a branch should be made with the prefix artfix/

Scene conflicts:

in each branch a duplicate scene should be made of the main scene. this temporary scene will act as a working space with the most up-to-date changes and should include any nessicary changes you might want to include.

when eventually merged the integration of these scenes will manually be implemented inside the mainscene by the lead developer and pushed directly to dev.

These scenes should be in their respective folder of branch prefixes so feature/main-menu should have a scene in the features folder named mainmenu

Pull requests:

When merging a branch to development a pull request must always be made, if the branch is a feature/ or hotfix/ the lead developer should check it and approve it by checking the code and potentially playtesting. when the branch is a art/ or artfix/ the lead artist should check on it if the art is corectly implemented inside the game