jami
/
jami-docs
mirror of https://git.jami.net/savoirfairelinux/jami-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

developer/new-developers/coding-style: cleanup 

linkify
rst format → md format for heading
guidances → guidance
to → for

Change-Id: I7b2df1987250a8ae2e1f0fa6e637d69671113a2b
This commit is contained in:
ovari123 2025-01-17 23:37:06 -04:00 committed by Pierre Nicolas
parent cb1632f371
commit e16bf1db04
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
developer/new-developers/coding-style.md
View File

@ -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>`.