Home | History | Annotate | Download | only in doc 
      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 <h2>Project Hosting</h2>
     22 
     23 <p>
     24   The JaCoCo project is hosted on
     25   <a href="https://github.com/jacoco/jacoco">GitHub</a> and can be cloned from
     26   this URL:
     27 </p>
     28 
     29 <pre>
     30   https://github.com/jacoco/jacoco.git
     31 </pre>
     32 
     33 <p>
     34   We also track all
     35   <a href="https://github.com/jacoco/jacoco/issues">issues</a> and
     36   <a href="https://github.com/jacoco/jacoco/pulls">pull requests</a>
     37   on the GitHub project.
     38 </p>
     39 
     40 
     41 <h3>IDE</h3>
     42 
     43 <p>
     44   JaCoCo development is done with the latest version of
     45   <a href="http://www.eclipse.org/">Eclipse</a>. Please make sure to install
     46   the <a href="http://www.eclipse.org/m2e/">m2e plug-in</a> to get all
     47   dependencies resolved properly. The source tree is organized as a list of
     48   Eclipse projects that can be imported in a Eclipse workspace.
     49 </p>
     50 
     51 <p>  
     52   Project specific Eclipse settings only exist for the following projects. All
     53   other projects and test projects link to these settings:
     54 </p>
     55 
     56 <ul>
     57   <li><code>org.jacoco.core</code></li>
     58   <li><code>org.jacoco.core.test</code></li>
     59 </ul>
     60 
     61 <p>
     62   These settings specify various compiler warnings and the standard Eclipse
     63   source formatting rules.
     64 </p>
     65 
     66 <h3>JRE/JDK</h3>
     67 
     68 <p>
     69   The minimum supported JRE version for JaCoCo is Java 1.5. To guarantee
     70   compatibility JaCoCo builds should always be executed against Java 1.5 JDK. In
     71   addition we run builds with 1.6, 1.7, 1.8 and 1.9 JDKs.
     72 </p>
     73 
     74 <h3>Build</h3>
     75 
     76 <p>
     77   The JaCoCo build is based on <a href="http://maven.apache.org/">Maven 3</a>.
     78   See the <a href="build.html">build description</a> for details.
     79 </p>
     80 
     81 <h3>Continuous Integration</h3>
     82 
     83 <p>
     84   We have a list of CI tools directly integrated with our source repository:
     85 </p>
     86 
     87 <ul>
     88   <li><a href="https://travis-ci.org/jacoco/jacoco/">Travis CI</a></li>
     89   <li><a href="https://ci.appveyor.com/project/JaCoCo/jacoco">AppVeyor</a></li>
     90 </ul>
     91 
     92 <p>
     93   CI builds run for master and every pull request.
     94 </p>
     95 
     96 <h3>Development Build Artifacts</h3>
     97 
     98 <p>
     99   Beside the <a href="http://search.maven.org/#search|ga|1|g%3Aorg.jacoco"> JaCoCo releases</a>
    100   the following build artifacts are automatically available during the
    101   development cycle:
    102 </p>
    103 
    104 <ul>
    105   <li><b>Master:</b> The current master is available through the Maven
    106     <a href="repo.html">snapshot repository</a>.</li>
    107   <li><b>Pull Requests:</b> For every pull request the
    108     <a href="https://ci.appveyor.com/project/JaCoCo/jacoco">AppVeyor builds</a>
    109     provide the corresponding all-in-one zip for download. To access the
    110     artifacts follow the check <code>continuous-integration/appveyor/branch</code>
    111     on the corresponding GitHub pull request page.</li>
    112 </ul>
    113 
    114 <h3>Continuous Inspection</h3>
    115 
    116 <p>
    117   We track quality issues with our source code with
    118   <a href="http://nemo.sonarqube.org/dashboard/index/org.jacoco:org.jacoco.build">SonarQube</a>.
    119 </p>
    120 
    121 <h3>Communication</h3>
    122 
    123 <p>
    124   The development team communicates through a mailing list. The list is closed
    125   for non-developers but the archive is
    126   <a href="https://groups.google.com/d/forum/jacoco-dev">public</a>.
    127   Please use the <a href="support.html">support channels</a> to get in touch
    128   with the development team.
    129 </p>
    130 
    131 </div>
    132 <div class="footer">
    133   <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
    134   <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
    135 </div>
    136 
    137 </body>
    138 </html>
    139