1<?xml version="1.0" encoding="UTF-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
4<head>
5  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6  <link rel="stylesheet" href=".resources/doc.css" charset="UTF-8" type="text/css" />
7  <link rel="shortcut icon" href=".resources/report.gif" type="image/gif" />
8  <title>JaCoCo - Development Environment</title>
9</head>
10<body>
11
12<div class="breadcrumb">
13  <a href="../index.html" class="el_report">JaCoCo</a> &gt;
14  <a href="index.html" class="el_group">Documentation</a> &gt;
15  <span class="el_source">Development Environment</span>
16</div>
17<div id="content">
18
19<h1>Development Environment</h1>
20
21<p>
22  JaCoCo is currently hosted at
23  <a href="https://github.com/jacoco/jacoco">GitHub</a>. This document provides
24  an overview of the local and shared tools used for JaCoCo development.
25</p>
26
27<h3>IDE</h3>
28
29<p>
30  JaCoCo development is done with the latest version of
31  <a href="http://www.eclipse.org/">Eclipse</a>. Please make sure to install
32  the <a href="http://www.eclipse.org/m2e/">m2e plug-in</a> to get all
33  dependencies resolved properly.
34</p>
35
36<p>
37  Project specific Eclipse settings only exist for the following projects. All
38  other projects and test projects link to these settings:
39</p>
40
41<ul>
42  <li><code>org.jacoco.core</code></li>
43  <li><code>org.jacoco.core.test</code></li>
44</ul>
45
46<h3>JRE/JDK</h3>
47
48<p>
49  The minimum JRE version to execute JaCoCo is Java 1.5. To guarantee
50  compatibility JaCoCo builds should always be executed against Java 1.5 JDK. In
51  addition we run builds with 1.6, 1.7 and 1.8 JDKs.
52</p>
53
54<h3>Build</h3>
55
56<p>
57  The JaCoCo build is based on <a href="http://maven.apache.org/">Maven 3</a>.
58  We have a <a href="https://jacoco.ci.cloudbees.com/">continuous build</a>
59  which is kindly provided by <a href="http://www.cloudbees.com/">CloudBees</a>.
60  Continuous builds from the master branch are directly published to the
61  <a href="repo.html">snapshot repository</a>.
62</p>
63
64<p>
65  We do also use
66  <a href="http://nemo.sonarqube.org/dashboard/index/org.jacoco:org.jacoco.build">continuous inspection</a>
67  with <a href="http://www.sonarqube.org/">SonarQube</a>.
68</p>
69
70<h3>Source Rules</h3>
71
72<ul>
73  <li>
74    <b>Encoding:</b> All source files and HTML documents are encoded in UTF-8
75    unless an alternative encoding is required by the file format specification.
76    For example Java property files are always encoded in ISO-8859-1.
77  </li>
78  <li>
79    <b>Formatting:</b> The Eclipse project settings define auto-formatter
80    settings for all Java classes. Make sure you apply the Eclipse formatter to
81    source files before committing.
82  </li>
83  <li>
84    <b>Warnings:</b> The Eclipse project settings define several compiler
85    warnings. JaCoCo projects must not show any Eclipse warnings.
86  </li>
87</ul>
88
89<h3>Source Control</h3>
90
91<p>
92  The JaCoCo source code is maintained in a Git repository at
93  <a href="https://github.com/jacoco/jacoco">GitHub</a> and can be cloned from
94</p>
95
96<pre>
97  https://github.com/jacoco/jacoco.git
98</pre>
99
100<p>
101  The source tree is organized as a plain list of Eclipse projects that can be
102  imported in a Eclipse workspace.
103</p>
104
105<h3>Issue Tracking</h3>
106
107<p>
108  This GitHub <a href="https://github.com/jacoco/jacoco/issues">issue tracker</a>
109  is used for bug and enhancement tracking.
110</p>
111
112<h3>Communication</h3>
113
114<p>
115  The development team communicates through a mailing list. The list is closed
116  for non-developers but the archive is
117  <a href="https://groups.google.com/d/forum/jacoco-dev">public</a>.
118  Please use the <a href="support.html">support channels</a> to get in touch
119  with the development team.
120</p>
121
122</div>
123<div class="footer">
124  <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
125  <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
126</div>
127
128</body>
129</html>
130