Development Environment

JaCoCo is currently hosted at GitHub. This document provides an overview of the local and shared tools used for JaCoCo development.

IDE

JaCoCo development is done with the latest version of Eclipse. Please make sure to install the m2e plug-in to get all dependencies resolved properly.

Project specific Eclipse settings only exist for the following projects. All other projects and test projects link to these settings:

• org.jacoco.core
• org.jacoco.core.test

JRE/JDK

The minimum JRE version to execute JaCoCo is Java 1.5. To guarantee compatibility JaCoCo builds should always be executed against Java 1.5 JDK. In addition we run builds with 1.6, 1.7 and 1.8 JDKs.

Build

The JaCoCo build is based on Maven 3. We have a continuous build which is kindly provided by CloudBees. Continuous builds from the master branch are directly published to the snapshot repository.

We do also use continuous inspection with SonarQube.

Source Rules

• Encoding: All source files and HTML documents are encoded in UTF-8 unless an alternative encoding is required by the file format specification. For example Java property files are always encoded in ISO-8859-1.
• Formatting: The Eclipse project settings define auto-formatter settings for all Java classes. Make sure you apply the Eclipse formatter to source files before committing.
• Warnings: The Eclipse project settings define several compiler warnings. JaCoCo projects must not show any Eclipse warnings.

Source Control

The JaCoCo source code is maintained in a Git repository at GitHub and can be cloned from

  https://github.com/jacoco/jacoco.git

The source tree is organized as a plain list of Eclipse projects that can be imported in a Eclipse workspace.

Issue Tracking

This GitHub issue tracker is used for bug and enhancement tracking.

Communication

The development team communicates through a mailing list. The list is closed for non-developers but the archive is public. Please use the support channels to get in touch with the development team.