jami-docs/developer/new-developers/coding-style.md

13 lines
631 B
Markdown
Raw Normal View History

# Coding style
**This page provides rules and/or guidance for developers wanting to integrate code into Jami.**
2020-09-02 01:31:50 +08:00
C++ format rules are defined by the following clang-format file:
<https://git.jami.net/savoirfairelinux/jami-daemon/blob/master/.clang-format>.
2020-09-02 01:31:50 +08:00
QML format rules are defined by the source code used to build the qmlformat executable:
<https://codebrowser.dev/qt6/qtdeclarative/tools/qmlformat/qmlformat.cpp.html>.
It is recommended that developers format their code using the `jami-project/scripts/format.sh` script.
This is done automatically (as a pre-commit hook) when using `./build.py --init --qt=<path-to-qt>`.