[95a960]: docs / contributing.html Maximize Restore History

Download this file

contributing.html    137 lines (118 with data), 4.9 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Contributing to Checkstyle</title>
<link rel="stylesheet" type="text/css" href="mystyle.css"/>
</head>
<body>
<!-- The header -->
<table border="0" width="100%" summary="header layout">
<tr>
<td>
<h1>Contributing to Checkstyle</h1>
</td>
<td align="right">
<img src="logo.png" alt="Checkstyle Logo"/>
</td>
</tr>
</table>
<!-- content -->
<table border="0" width="100%" cellpadding="5" summary="body layout">
<tr>
<!--Left menu-->
<td class="menu" valign="top">
<p>Contributing</p>
<ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#quality">Quality</a></li>
<li><a href="#submit">Submitting</a></li>
</ul>
</td>
<!--Content-->
<td class="content" valign="top" align="left">
<a name="intro"></a>
<h2>Introduction</h2>
<p class="body">
Hey, good to see you on this page. It means that you are
considering a contribution of your own work to the Checkstyle
project. We welcome anything: bugfixes, new check modules, unit
tests, documentation improvements, build process simplification,
etc.
</p>
<p class="body">
This document assumes you are working with the CVS version of
checkstyle and that you are familiar with some standard
development tools (<a href="http://www.cvshome.org">CVS</a>,
<a href="http://ant.apache.org">Ant</a>, <a
href="http://www.junit.org">JUnit</a>).
</p>
<a name="quality"></a>
<h2>Quality matters</h2>
<p class="body">
The developer team of checkstyle is really a lazy bunch of
people. We try to avoid work as best as we can, but most of all
we try to avoid working on bugs that are reported by end users.
</p>
<p class="body">
To that end, we use a set of development tools that ensure that the
quality of our code is kept at a fairly high level. Like most projects
today, we use JUnit to test our code. However we do take this one
step further and measure the coverage of our unit tests using
<a href="http://www.thecortex.net/clover">Clover</a>. This means it
is not sufficient to pass all tests, but the tests should ideally
execute each line in the code. The most recent Clover report is
available <a href="http://checkstyle.sourceforge.net/clover_html/">here</a>.
</p>
<p class="body">
Besides using unit testing, we obviously also use checkstyle to check
it's own code.
</p>
<p class="body">
We have the build target <span class="code">gump</span> in our
Ant buildfile that builds checkstyle, executes all tests,
and runs checkstyle on it's own code.
That target should pass without errors.
</p>
<p class="body">
If you add new end user features, remember to document them.
</p>
<a name="submit"></a>
<h2>Submitting your contribution</h2>
<p class="body">
Once you have made sure that your changes pass the gump target,
and everthing is documented, you are ready to submit your work.
</p>
<p class="body">
If you have created new files, put them in a tgz file (or zip if you
are on Windows). If you have changed existing files, create a unified
diff using CVS. To do that, open a command line, cd to the home
directory of checkstyle (where build.xml is located) and execute
<span class="code">cvs diff -u &gt; mychanges.patch</span>.
</p>
<p class="body">
Create a new item in our
<a href="http://sourceforge.net/tracker/?group_id=29721&amp;atid=397080">patch tracker</a>
and add the tgz/zip/patch files you created.
Make sure the text in the tracker explains the purpose of your contribution.
When you create a tracker entry, a notification email about your contribution
will automatically be sent to the developer mailing list.
Be prepared to answer questions and do some polishing work.
</p>
<p class="body">
We are not only lazy but at times we are also busy with our day jobs.
This means that you might not always get an immediate answer. You are
not being ignored, and we value your work - we might just be too busy
to review your code, especially if it is a bit complex. If you don't
get a response within two weeks, feel free to send a reminder email about
your tracker item.
</p>
</td>
</tr>
</table>
<hr/>
<div><a href="index.html">Back to the Checkstyle Home Page</a></div>
<p class="copyright">Copyright &copy; 2002-2004 Oliver Burn. All rights Reserved.</p>
</body> </html>