What is a Branch ?
A branch represents an independent line of development.
Branches allow you to develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository.
You always create a branch from an existing branch. In CommunityAPI, you might create a new branch from the dev branch.
Visit How to Contribute ? to learn how to use the branches.
-
master= Stable released version (Live version on Steam Workshop). -
dev= Development version.
-
feature= Created fromdevbranch when creating or developing a feature. -
release= Created fromdevbranch target features are ready for an update. -
hotfix= Created frommasterbranch when a hotfix need to be done.
May branch off from: dev
Must merge back into: dev
May branch off from: dev
Must merge back into: dev & master
May branch off from: master
Must merge back into: dev & master
If your changes only update Documentations:
You may name it <api_name/feature_name>-doc-update
If your changes is a new api/feature:
You may name it <api_name/feature_name>-new
If your changes modify or fix an existing feature:
You may name it <api_name/feature_name>-update or <api_name/feature_name>-fix
Those keywords are reserved for specific branches.
You cannot use dev, release or hotfix in the naming of your branch for common development.
Your branch will automatically be deleted from the remote repository, as the changes have been integrated.
If the remote branch is deleted and you didn't finish (Still have commits) on your local machine, you will be able to re-publish it and make a new Pull request.
After a Pull request is merged and the branch deleted from the remote, on your local machine the branch will remain, if you do not have new commits in that branch you can delete it safely to keep it clean.
