CONTRIBUTING.md



Contributing to pugs


Branches
develop and master branches are protected. This means that one
cannot push on them, so before to do any code change one has to
create a working branch. The following conventions are greatly
encouraged:

feature/my_outstanding_feature

issue/issue-number (if no number is related to the issue please
consider opening an
issue and assign it to
yourself)


Tests and coverage

Running tests
Tests are built automatically and are run typing

make; make test

all tests should be running correctly before any merge request

Unit tests
Unit tests are defined in the tests directory. New unit tests should
be written or updated when needed.

Coverage
Preferably, one should install gcovr and build
pugs specifying the Coverage build type > cmake -DCMAKE_BUILD_TYPE=Coverage [...]
However coverage is computed at each push by the gitlab-ci.


Up to date build environment using Docker

This is the easiest way to keep your environment up to date in order
to build pugs.
Running the docker-pugs.sh script creates the
image and runs it in interactive mode. The image will runs the user's
permissions and his home directory is mounted.