Branching Strategy

This repository follows the GitFlow Workflow. If you are not familiar, please review this article.

Think Before you Fork

Before you create a fork, it is advisable to create an issue on the github page. That way, the maintainers can let you know if that feature or bugfix is already under development.

Please consult the maintainers before you create a fork that will change existing behaviors.

Fixing a Bug in Production Code

To fix a bug make a create a branch from master. This branch should be labeled hotfix/x.y.z-description where x.y.z follow the semantic versioning convention.

When the bugfix is complete, make a pull request back to master and the maintainers will review and merge it.

Adding a Feature

If you wish to add a new feature, please make a fork from the devel branch.

Once your modification is completed, make a pull request back to the devel branch. If it is accepted, your modifications will be available in the master branch (default branch) after the next release.

Additional Guidelines

Please review and adhere to the style guidelines our Development Conventions.