Conventions
=================

Coding Conventions in C++
----------------------------

This project uses following linters:

- `clang-tidy <https://clang.llvm.org/extra/clang-tidy/>`_ for C++.

This project uses following formatters:

- `clang-format <https://clang.llvm.org/docs/ClangFormat.html>`_ for C++,
- `cmake-format <https://github.com/cheshirekow/cmake_format>`_ for CMake,
- `Black <https://black.readthedocs.io/en/stable/>`_ for Python,
- `Prettier <https://prettier.io/>`_ for Markdown, YAML, JSON.

This project uses following tools for documentation:

- `Doxygen <https://www.doxygen.nl/index.html>`_,
- `Sphinx <https://www.sphinx-doc.org/>`_.

This project uses following tools for dependency management:

- `poetry <https://python-poetry.org/>`_ (Python),
- `vcpkg <https://vcpkg.io>`_ (C++).