Contribution Guide

Requirements

If you don't use docker-wrapped commands, make sure that tools you use have the same version as in docker-wrapped commands. It's latest version, mainly.

Take a look at Makefile for commands usage details.

Use docker-compose from Makefile to boot up (or restart) dockerized environment for development:

make up
make down

# or without Docker image rebuilding
make up rebuild=no

# or run in background mode
make up background=yes

To preload project dependencies use docker-wrapped command from Makefile:

make deps

To build/rebuild project Docker image use docker-wrapped command from Makefile:

make build

To generate JavaDoc documentation of project use docker-wrapped command from Makefile:

make docs
# available in target/site/ dir