This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.


What does your user need to know to try your project?

1 - Developer Guide

How to set up your environment for developing on Jikkou.


Building Jikkou

We use Maven Wrapper to build our project. The simplest way to get started is:

For building distribution files.

$ ./mvnw clean package -Pdist -DskipTests

Alternatively, we also use Make to package and build the Docker image for Jikkou:

$ make

Running tests

For running all tests and checks:

$ ./mvnw clean verify

Code Format

This project uses the Maven plugin Spotless to format all Java classes and to apply some code quality checks.

Bugs & Security

This project uses the Maven plugin SpotBugs and FindSecBugs to run some static analysis to look for bugs in Java code.

Reported bugs can be analysed using SpotBugs GUI:

$ ./mvnw spotbugs:gui

2 - Contribution Guidelines

How to contribute to Jikkou

Jikkou is an open source project, and we love getting patches and contributions to make Jikkou and its docs even better.

Contributing to Jikkou

The Jikkou project itself lives in

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Creating issues

Alternatively, if there’s something you’d like to see in Jikkou (or if you’ve found something that isn’t working the way you’d expect), but you’re not sure how to fix it yourself, please create an issue.