Development workflow

Some notes

• master branch is used for publish stable releases
• develop branch is used to sync updates from developers
• Keep track of development notes in the wiki page Development notes

A simple workflow

For new features and non-urgent bugfixes

• Write down the update item in Development notes (under 'todo' or 'in progress')
• Create a new branch
• Make development
• Once done
  • Merge the branch to 'develop'
  • Fix any conflicting issues
  • Move the item in the development notes to 'done'

For new release

For example, a new release with version 1.2

• Create a new section 'Release (1.2)' under 'done' in Development notes
• Move everything under 'done' to the new 'release' section
• Create a new branch rc-1.2 from the current develop branch ('rc' stands for 'release candidate)
• Update the CHANGELOG. Copy everything in the development notes for this release to the CHANGELOG
• Test each item in the update
• Once done, merge this branch to master and create the release package.

For hotfix

For example, there is a serious bug in the release version 1.2 that needs to be fixed immediately.

• Create a new branch hotfix-1.2.1 from the master branch
• Fix bugs
• Once done and past tests
  • Merge the branch to master and create the new release package (1.2.1)
  • Merge the branch to develop

Ref

• https://nvie.com/posts/a-successful-git-branching-model/