From e16bf1db041d9f0445e61cf3f07532f40f023248 Mon Sep 17 00:00:00 2001 From: ovari123 <ovari123@zoho.com> Date: Fri, 17 Jan 2025 23:37:06 -0400 Subject: [PATCH] developer/new-developers/coding-style: cleanup MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit linkify rst format → md format for heading guidances → guidance to → for Change-Id: I7b2df1987250a8ae2e1f0fa6e637d69671113a2b --- developer/new-developers/coding-style.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/developer/new-developers/coding-style.md b/developer/new-developers/coding-style.md index 54cf0d20..812584d6 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>`. -- GitLab