diff --git a/developer/new-developers/coding-style.md b/developer/new-developers/coding-style.md index 54cf0d2066318a902d87bf5f6ae9cf4e22b87d11..812584d6d220ff7ef98c392f6b59919e49c03b14 100644 --- a/developer/new-developers/coding-style.md +++ b/developer/new-developers/coding-style.md @@ -1,14 +1,12 @@ -Coding style -============ +# Coding style -**This page gives rules and/or guidances to all -developers that want to integrate some code to Jami** +**This page provides rules and/or guidance for developers wanting to integrate code into Jami.** -C++ format rules are defined by this clang-format file: -https://git.jami.net/savoirfairelinux/jami-daemon/blob/master/.clang-format +C++ format rules are defined by the following clang-format file: +<https://git.jami.net/savoirfairelinux/jami-daemon/blob/master/.clang-format>. 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 +<https://codebrowser.dev/qt6/qtdeclarative/tools/qmlformat/qmlformat.cpp.html>. -All developers are recommended to format their code using the script in `jami-project/scripts/format.sh`. +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>`.