2025-01-18 11:37:06 +08:00
|
|
|
# Coding style
|
2022-07-28 03:08:40 +08:00
|
|
|
|
2025-01-18 11:37:06 +08:00
|
|
|
**This page provides rules and/or guidance for developers wanting to integrate code into Jami.**
|
2020-09-02 01:31:50 +08:00
|
|
|
|
2025-01-18 11:37:06 +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
|
|
|
|
2023-04-12 21:12:54 +08:00
|
|
|
QML format rules are defined by the source code used to build the qmlformat executable:
|
2025-01-18 11:37:06 +08:00
|
|
|
<https://codebrowser.dev/qt6/qtdeclarative/tools/qmlformat/qmlformat.cpp.html>.
|
2023-04-12 21:12:54 +08:00
|
|
|
|
2025-01-18 11:37:06 +08:00
|
|
|
It is recommended that developers format their code using the `jami-project/scripts/format.sh` script.
|
2023-04-12 21:12:54 +08:00
|
|
|
This is done automatically (as a pre-commit hook) when using `./build.py --init --qt=<path-to-qt>`.
|