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