Create a branch for your contribution with a meaningful title relevant to the task only.
Stick to the following Commit Format:
<type> (optional scope): short summary in present tense
scope
is where the change was madetype
could be:
feat
A new featurefix
a bug fixdocs
documentation changesstyle
changes that do not affect the meaning of the code ( formatting …)refactor
a code change that neither fixes a bug nor adds a featureperf
a code change that improves performancetest
changes to the test frameworkbuild
changes to the build process or toolsOnce ready for review, Create a Pull Request
Solve any merging conflicts
Your Pull Request will be reviewed
Address the Review
Once approved, it will be merged to main and the branch will be deleted.
Then for each New Task: Repeat the above routine from 1 to 7
Version Numbering in Our Workflow
We follow semantic versioning (A.B.C
):
Most releases will be patch or minor updates. Major releases occur when breaking changes are necessary.