Skip to content

Latest commit

 

History

History
126 lines (84 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

126 lines (84 loc) · 3.46 KB

Contributing

Getting started

There are many dependencies, some of which are currently not very convenient to install, so the easiest way to build locally is probably to use the pre-compiled static libraries used by the CI builds - see ci/README for more details.

Linux local build

Clone the repo including sub-modules:

git clone --recursive https://github.com/spatial-model-editor/spatial-model-editor.git
cd spatial-model-editor

Download the latest static libs and copy them to /opt/smelibs:

sudo ./ext/getdeps.sh

Make sure you have the necessary libraries installed, for example on Ubuntu:

sudo apt-get install \
    libglu1-mesa-dev \
    libx11-dev \
    libx11-xcb-dev \
    libxext-dev \
    libxfixes-dev \
    libxi-dev \
    libxrender-dev \
    libxcb1-dev \
    libxcb-glx0-dev \
    libxcb-keysyms1-dev \
    libxcb-image0-dev \
    libxcb-shm0-dev \
    libxcb-icccm4-dev \
    libxcb-sync-dev \
    libxcb-xfixes0-dev \
    libxcb-shape0-dev \
    libxcb-randr0-dev \
    libxcb-render-util0-dev \
    libxkbcommon-dev \
    libxkbcommon-x11-dev \
    libfreetype-dev \
    libfontconfig-dev \
    '^libxcb.*-dev'

Build using CMake, e.g.

mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="/opt/smelibs;/opt/smelibs/lib/cmake" -DSME_EXTRA_EXE_LIBS="-ltirpc"

Depending on how your system differs from the CI server where these static libs were compiled, you may not need -DSME_EXTRA_EXE_LIBS="-ltirpc", or you may need to add something else. Now you can run the tests, see test/README.md for more information:

make test

Style guide

  • C++17

  • each component X has a X.hpp, X.cpp and X_t.cpp, where the latter contains the tests

  • some components also have benchmarks in X_bench.cpp

  • follow sonarcloud static analysis suggestions where possible

  • avoid platform-dependent code: we support linux / macOS / windows

Pull requests

  • pull requests are built and tested on github actions

  • static analysis report from sonarcloud

  • test coverage report from codecov

  • documentation will also be built, see docs/README for more information

  • code formatting will be checked and fixed if necessary (see pre-commit hooks below)

  • all must pass before a pull request can be merged

  • see ci/README for more information on how this works

pre-commit hooks

  • pre-commit hooks to check & fix code formatting are available

  • to use them, first install pre-commit:

    • pip install pre-commit

  • then in the directory where you cloned this repo run:

    • pre-commit install

  • every subsequent git commit will check for (and fix)

    • trailing whitespace

    • end of file newline

    • yaml errors

  • and run these tools:

  • a CI job also runs these checks, and will automatically add a commit with any required fixes