Commit rules - DigitalMediaProfessionals/dv-sdk GitHub Wiki

The repository is split up in submodules. The root repository is setup to use the stable version of each submodule.

The master branch of each repository is protected.
When you start developing, first check out a new branch to work:
git checkout -b <new branch name>

After you are done with the modification and want to merge with the master branch,
push your branch by git push origin <new branch name>.
Then send a Merge Request from the Repository -> Branched page to one of the repository master.

coding style

Please test your code before you commit.

To the goal, git hook is useful. Here are sample codes of git hook.

• check PEP8 | pre-push

dv-user-driver API headers must be plain C99 compatible, functions and structures should be prefixed with dmp_dv_, constants with DMP_DV_. Subject of the function should follow prefix, for example dmp_dv_mem_get_size is better than dmp_dv_get_mem_size.

dv-user-driver source code and C++ files in other projects in general should follow Google C++ Style Guide and be C++11 compatible.

dv-kernel-driver repository should use Linux kernel coding style.

Python scripts should follow PEP8 with reasonable exceptions: pep8 --ignore=E402 (module level import not at top of file). Exception are possible if they are reasonable and do not reduce readability.