How to walk with your contribution using github

  1. Create a branch for your contribution with a meaningful title relevant to the task only.

  2. Stick to the following Commit Format:

    <type> (optional scope): short summary in present tense

    1. scope is where the change was made
    2. The type could be:
      1. feat A new feature
      2. fix a bug fix
      3. docs documentation changes
      4. style changes that do not affect the meaning of the code ( formatting …)
      5. refactor a code change that neither fixes a bug nor adds a feature
      6. perf a code change that improves performance
      7. test changes to the test framework
      8. build changes to the build process or tools
  3. Once ready for review, Create a Pull Request

  4. Solve any merging conflicts

  5. Your Pull Request will be reviewed

  6. Address the Review

  7. Once approved, it will be merged to main and the branch will be deleted.

  8. 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.