Skip to content

Git Workflow

Duck edited this page Nov 30, 2021 · 2 revisions

In this project, we use Github Flow.

main branch contains current code and while compiling, might be unstable and buggy, task/... are for implementing features, fixing bugs and introduction changes

When you want to contribute:

  1. Choose a task to do
  2. Create corresponding task branch
  3. Commit to said branch changes, those commits can even contain code that does not compile
  4. When you are done with the task, Pull Request to main
  5. The branch is merged with the main one and can be safely removed

(refer to Styling Guide for more information regarding naming)

Releases are done as release/... branch and upon merging are tagged with appropriate version tag. Those tags point at commits with relatively stable code

Version tags are prefixed with v... and follow the semantic versioning, for example branch release/0.4 would result in v0.4 tag and branch hotfix/0.4.6 would result in v0.4.6 tag

Clone this wiki locally