Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 1.04 KB
Raw

Contributing

Formatting

Please format your code before opening pull requests using clang-format and the .clang-format file placed in the repository root.

Visual Studio and CLion

Suport for clang-format is built-in since Visual Studio 2017 15.7 and CLion 2019.1. The .clang-format file in the repository will be automatically detected and formatting is done as you type, or triggered when pressing the format hotkey.

Bash

First install clang-format. Instructions therefore can be found on the web. To format your changes since branching off develop, you can run this command in bash:

git clang-format develop

To format all code in your working copy, you can run this command in bash:

find -iname *.cpp -o -iname *.hpp | xargs clang-format -i

Tests

LLAMA comes with a suite of unit tests that you can run before opening a pull request. Building the unit tests is enabled by setting BUILD_TESTING to ON in cmake. You can then build and run the tests target:

cd build
cmake -DBUILD_TESTING=ON ..
make tests
./tests