Git branches and branch naming convention - Artq99/xeus-pygame-extensions GitHub Wiki

Main branches

The main branches represent the states of the framework development and they are described below:

master - this branch always represents the current stable version.
master_v<x>.<y> - these branches represent the final state of the release marked by x and y. The master branch always has the state equal to the newest of them. After all the changes have been merged and tested into the current development branch, its state is merged into a new master branch. Example: master_v1.2
dev_v<x>.<y> - these are the development branches. All the feature branches and bug fix branches are being merged into the current development branch. Example: dev_v1.3

The branch naming convention used in this project for the branches created for resolving issues is as follows:

fb_#<n> - feature branch. n represents the ID of the issue on GitHub. Generally these branches are related to the issues that introduce new functionality, extend the existing one, or make the code more robust (e.x. unit tests).
bf_#<n>- bug fix branch. n represents the ID of the issue on GitHub. These branches are related to the issues marked as a bug.
hf_#<n>- hot fix branch, n represents the ID of the issue on GitHub. These branches are related to the critical bugs, that need to be resolved as quick as possible, and they are not merged into a development branch and wait to the next release, but they go directly into the current master branch.