Gitflow Workflow

Workflow description

This project uses the gitflow workflow.

Working on a feature

• create develop-foo-feature branch from develop
• write code, push commits to develop-foo-feature
• once ready, create pull request from develop-foo-feature to develop
• we will discuss and review the changes, adjust if required and commit changes to ‘develop-foo-feature`
• once all issues are worked through, we will merge develop-foo-feature into develop

Feature Freeze - Creating the Release branch

Once develop has acquired enough features for a release, a release branch is forked off of develop. Creating this branch starts the next release cycle, so no new features can be added after this point. Only the following commits are accepted:

• Bug fixes
• Documentation generation
• other release-oriented tasks

Once it's ready to ship, the release branch gets merged into master. In addition, it gets merged back into develop, which may have progressed since the release was initiated.

Merging Release into master

• update the changelog in develop with the changes.
• create a pull request from develop to master
• Admin will assign a version number to the pull request iaw semantic versioning guidelines and merge the pull request into master.