Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / jacoco / 5737e6231fc3c7e4a37429a43aa9d7e352d20b48 / . / org.jacoco.doc / docroot / doc / conventions.html
blob: 4defcc48eca3282801cdc4f9d1213032c296fc71 [file] [log] [blame]
Marc R. Hoffmannadc97d92009-10-16 08:24:59 +0000[diff] [blame]1<?xml version="1.0" encoding="ISO-8859-1" ?>
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=ISO-8859-1" />
6 <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
7 <title>JaCoCo - Development Conventions</title>
8</head>
9<body>
10
11<div class="breadcrumb">
12 <a href="../index.html" class="el_session">JaCoCo</a> &gt;
13 <a href="index.html" class="el_group">Documentation</a> &gt;
14 <span class="el_source">Development Conventions</span>
15</div>
16
17<h1>Development Conventions</h1>
18
19<p>
20 Efficient team work that produces high-quality software requires a common set
21 of rules.
22</p>
23
24<h3>Consistent Source Tree</h3>
25
26<p>
27 Update your sources and run the build locally before every check-in. Commit
28 only if the build succeeds.
29</p>
30
31<p>
32 Documentation is part of the product. Whenever you implement a new feature or
33 change existing behavior make sure to update all corresponding JavaDoc as well
34 as other documentation with the same change set. The product should always be
Marc R. Hoffmann5737e622010-01-26 20:03:52 +0000[diff] [blame^]35 in a consistent state. For every change the following items should be checked:
Marc R. Hoffmannadc97d92009-10-16 08:24:59 +0000[diff] [blame]36</p>
37
Marc R. Hoffmann5737e622010-01-26 20:03:52 +0000[diff] [blame^]38<ul>
39 <li>Corresponding JavaDoc.</li>
40 <li>Documentation referring to the modified concepts, interfaces or
41 implementation.</li>
42 <li>New features, bug fixes and modified behavior should be enlisted in the
43 <code>org.jacoco.doc/docroot/doc/changes.html</code> file together with
44 the corresponding issue tracker id.</li>
45</ul>
46
Marc R. Hoffmannadc97d92009-10-16 08:24:59 +0000[diff] [blame]47<h3>Keep an Eye on License Issues</h3>
48
49<p>
50 All code included with JaCoCo must conform to the EPL license.
51</p>
52
53<ul>
Marc R. Hoffmann5737e622010-01-26 20:03:52 +0000[diff] [blame^]54 <li>
55 Every committer and contributor must agree that all code will be published
56 under EPL. He or she must be the original author and must have the
57 permission to contribute code to JaCoCo, for example if such a permission
58 is required by the employer.
59 </li>
60 <li>
61 Every third party content must be enlisted in the corresponding
62 <code>about.html</code> file along with its license.
63 </li>
64 <li>
65 Every third party content included with the JaCoCo distribution must be
66 enlisted in the <code>org.jacoco.doc/docroot/doc/license.html</code> file
67 and the corresponding <code>about.html</code> file along with its license.
68 </li>
69 <li>
70 Every source file (Java, Build Script, DTD) must have a
71 <a href="http://www.eclipse.org/legal/copyrightandlicensenotice.php">EPL
72 license notice</a>. The initial contributor should be listed. In case of
73 significant changes or additions additional contributors should also
74 be listed.
Marc R. Hoffmannadc97d92009-10-16 08:24:59 +0000[diff] [blame]75 </li>
76</ul>
77
Marc R. Hoffmannadc97d92009-10-16 08:24:59 +0000[diff] [blame]78<div class="footer">
79 <div class="versioninfo"><a href="@HOMEURL@">JaCoCo</a> @VERSION@</div>
Marc R. Hoffmann5737e622010-01-26 20:03:52 +0000[diff] [blame^]80 <a href="license.html">Copyright</a> &copy; 2009, 2010 Mountainminds GmbH &amp; Co. KG and Contributors
Marc R. Hoffmannadc97d92009-10-16 08:24:59 +0000[diff] [blame]81</div>
82
83</body>
84</html>