Skip to content

Coding Conventions

sepidetari edited this page Mar 24, 2019 · 12 revisions

Coding Guidelines

Code unification of PhASAR, in order to meet one unique standard in the framework, is done according to the LLVM coding guidelines, wherever is possible. The LLVM coding guidelines can be found here:

https://llvm.org/docs/CodingStandards.html

In addition, the pre-commit script in githooks/ need to be copied into the ./git/hooks/ directory:

$ cp githooks/pre-commit .git/hooks/

The script runs some useful clang-tidy checks as well as clang-format over the entire code base just before your changes are committed in order to prevent the number of unnecessary merge conflicts and to unify the code base.

Clone this wiki locally