We use the git-flow workflow to that extend, that branch names(paces) have a certain meaing:
Branch Name Pattern | Description |
---|---|
master | tip of the master branch is always the latest stable release |
development | tip of the development branch is the current state of development and not expected to be stable or even usable |
feature/* | various feature branches are used to implement new features and should be based off the development branch |
release/* | a release branch is created from the development branch and used to prepare a new release and will be merged into master |
hotfix/* | hotfix branches are based off master or development to fix important and severe bugs and should be merged into development and master as soon as possible |
Releases and release candidates are tagged in the form release-X.Y.Z(-RCa)
, where X
, Y
, and Z
specify the version with respect to semantic versioning and a
the number of the release candidate of that version.
To ease browsing the proejct's history, we try to keep our commit messages clean and descriptive. Please try to follow the following rules as best as possible:
Commit Title must not be longer than 50 characters
If applicable, the title should start with a category name (such as docu
, tests
, ...) followed by a colon (e.g. "docu: add usage
examples for plain SDC"
).
Please sign your commits (i.e. use git commit -s
)
This automatically appends a line of the form "Signed-off-by:
Torbjörn Klatt \<t.klatt\@fz-juelich.de\>"
to the end of the commit message.
development
branch and pull in the latest changesfeature/XYZ
where XYZ
is a short title of your planned feature (word seperation should be done with underscores, e.g. feature/my_awesome_feature
)