coding_guidelines.rst 602 Bytes
Newer Older
Colin Duquesnoy's avatar
Colin Duquesnoy committed
1
2
3
4
5
6
7
Coding guidelines
=================

We use the llvm code formating guidelines using clang-format.

We made a small script that will format any C++/javascript source file in the project to fit the style guidelines::

Colin Duquesnoy's avatar
Colin Duquesnoy committed
8
    sh scripts/beautify.sh
Colin Duquesnoy's avatar
Colin Duquesnoy committed
9

10
To run this tool, you need to install the following packages:
Colin Duquesnoy's avatar
Colin Duquesnoy committed
11

12
13
- **clang-format**: ``sudo pacman -S clang``
- **jsbeautifier**: ``sudo pip3 install jsbeautifier``
Colin Duquesnoy's avatar
Colin Duquesnoy committed
14
15


16
**Please, run this script before submitting a pull request!**
Colin Duquesnoy's avatar
Colin Duquesnoy committed
17
18


19
See the coding guidelines wiki page for more information: https://gitlab.com/ColinDuquesnoy/MellowPlayer/wikis/coding-guidelines