crossley 2004/07/22 21:00:44
Modified: site/community contrib.html
Log:
Clarify the licensing requirements.
Clarify the contribution procedure.
Revision Changes Path
1.10 +60 -48 cocoon-site/site/community/contrib.html
Index: contrib.html
===================================================================
RCS file: /home/cvs/cocoon-site/site/community/contrib.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- contrib.html 9 Jun 2004 20:28:28 -0000 1.9
+++ contrib.html 23 Jul 2004 04:00:43 -0000 1.10
@@ -98,29 +98,37 @@
<li>
<font color="#CFDCED">Navigation</font>
<ul>
+
<li>
<a href="../index.html">Main</a>
</li>
+
</ul>
</li>
<li>
<font color="#CFDCED">Community</font>
<ul>
+
<li>
<a href="members.html">Members</a>
</li>
+
<li>
<span class="sel"><font color="#ffcc00">Contributing</font></span>
</li>
+
<li>
<a href="committer.html">Committer Tips</a>
</li>
+
<li>
<a href="mail-lists.html">Mail Lists</a>
</li>
+
<li>
<a href="mail-archives.html">Mail Archives</a>
</li>
+
</ul>
</li>
</ul>
@@ -223,7 +231,8 @@
volunteer project under the auspices of the
<a href="http://www.apache.org/";>Apache Software Foundation (ASF)</a>,
and, in harmony with the Apache webserver itself, it is released under
- a very open license.
+ a very open
+ <a href="http://www.apache.org/licenses/";>license</a>.
This means there are many ways to contribute to the project - either
with direct participation (coding, documenting, answering questions,
proposing ideas, reporting bugs, suggesting bug-fixes, etc..) or by
resource
@@ -255,7 +264,7 @@
</div>
-<a name="N10041"></a><a name="Help+Wanted+Here"></a>
+<a name="N10045"></a><a name="Help+Wanted+Here"></a>
<h3>Help Wanted Here</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -302,39 +311,32 @@
</div>
-<a name="N10080"></a><a name="Contributions+of+Code+and+Documentation"></a>
+<a name="contrib"></a>
+ <a name="N10087"></a><a name="Contributions+of+Code+and+Documentation"></a>
<h3>Contributions of Code and Documentation</h3>
<div style="margin-left: 0 ; border: 2px">
-<p>We are starting to use an informal system for accepting contributions to
Cocoon.
- The process varies depending on whether the contribution is a
modification (i.e. patch)
- or a fairly standalone item, and whether you have commit access
(committers have been
- granted access by a vote of confidence, so they are assumed to be
trustworthy enough
- to make changes directly in CVS. If you submit many good patches, you may
be
- nominated as a committer yourself!)</p>
-<p>If your contribution requires changing more than a few lines of Cocoon
(code or
- documentation), then it counts as a <strong>patch</strong>. If you have a
patch and
- would like to see it incorporated into the Cocoon distribution, take note
of the Licensing
- Requirements listed below, and then read the section
- <a href="#procedure">Procedure for Raising Development Issues</a>
-
-</p>
-<p>A typical contribution (not a patch) may go through the following
stages:</p>
-<ol>
-
-<li>Posted to cocoon-users with a URL to download it from.</li>
-<!-- <li>Listed on 3rdparty.html by a maintainer. [No requirements, other
than relevance (at the moment).]</li> -->
-
-<li>Inclusion into the <span class="codefrag">contrib</span> directory,
- which is for 3rd-party contributions that have been tested, but are not
necessarily
- mature enough or general enough for the main distribution. [Must be
tested at least as
- specified below. See also Licensing Requirements below.]</li>
-
-<li>Inclusion into the main distribution. [Committers must be confident that
it should work properly in
- most/all environments, it must be documented as appropriate, and it must
be considered sufficiently
- useful and general to go into Cocoon. See also Licensing Requirements
below].</li>
-
-</ol>
-<a name="N100A8"></a><a
name="Testing+Requirements+for+Cocoon+Contrib+and+Distribution"></a>
+<p>
+ If you have a contribution that you would like to see incorporated into
+ the Cocoon distribution, then please take note of the
+ <a href="#license">licensing requirements</a> listed below,
+ and then read the section
+ <a href="#procedure">Procedure for Raising Development Issues</a>.
+ </p>
+<p>
+ The Cocoon committers have been granted access by a vote of confidence,
+ so they are assumed to be trustworthy enough to make changes directly in
+ CVS. Other contributors need to submit a patch via the Cocoon issue
+ tracker, Bugzilla.
+ </p>
+<p>
+ Committers must be confident that it would work properly in all operating
+ systems, it must be documented as appropriate, it must be considered
+ sufficiently useful and general to go into Cocoon, and it must meet the
+ Licensing requirements below. Other committers and developers will
continue
+ to enhance it, so don't be surprised if changes are made. Also the PMC
may
+ decide to remove it, if issues are discovered.
+ </p>
+<a name="N1009D"></a><a
name="Testing+Requirements+for+Cocoon+Contrib+and+Distribution"></a>
<h4>Testing Requirements for Cocoon Contrib and Distribution</h4>
<div style="margin-left: 0 ; border: 2px">
<p>All new code should be tested under at least the following servlet
engines:</p>
@@ -361,7 +363,7 @@
if someone else tests it, because the contributor might be tempted to do
less
than thorough testing!</p>
</div>
-<a name="N100CC"></a><a
name="Documentation+Requirements+for+Cocoon+Distribution"></a>
+<a name="N100C1"></a><a
name="Documentation+Requirements+for+Cocoon+Distribution"></a>
<h4>Documentation Requirements for Cocoon Distribution</h4>
<div style="margin-left: 0 ; border: 2px">
<p>All new features (processor, logicsheets, config options etc.) should be
documented
@@ -372,19 +374,23 @@
documentation build.
</p>
</div>
-<a name="N100E7"></a><a
name="Licensing+Requirements+for+the+Cocoon+Distribution"></a>
+<a name="license"></a><a name="N100DF"></a><a
name="Licensing+Requirements+for+the+Cocoon+Distribution"></a>
<h4>Licensing Requirements for the Cocoon Distribution</h4>
<div style="margin-left: 0 ; border: 2px">
<p>To avoid legal problems, the Apache Project Management Committee (PMC)
have agreed on
a policy for under what licensing code can be accepted into Apache
projects:</p>
<ul>
-<li>Source code files must be under the Apache license and must have
copyright assigned to
+<li>Source code files (which include every file, code and documentation)
+ must be under the
+ <a href="http://www.apache.org/licenses/";>Apache license</a>.
+ and must have copyright assigned to
the Apache Software Foundation.</li>
-<li>Jar files need only be released under a license that permits free
redistribution
- and does not cover new files added to the jar/library (so the GPL and
LGPL are not allowed,
- but MPL and Apache licenses are, for example).</li>
+<li>Jar files need to be released under a license that permits free
+ redistribution (i.e. not any more restrictive than the Apache License).
+ So for example, the GPL and LGPL are not allowed,
+ but MPL and Apache licenses are allowed.</li>
</ul>
<p>
@@ -402,7 +408,7 @@
<a name="cvshowto"></a>
- <a name="N1010A"></a><a name="CVS+Usage+Precis"></a>
+ <a name="N10106"></a><a name="CVS+Usage+Precis"></a>
<h3>CVS Usage Precis</h3>
<div style="margin-left: 0 ; border: 2px">
<p>An overview of how to use CVS to participate in Cocoon development.
@@ -423,7 +429,7 @@
repository, how to keep it up-to-date, and how to generate the differences
to create a patch. (The commands are for Linux.)
</p>
-<a name="N10122"></a><a name="How+to+Establish+your+Local+Repository"></a>
+<a name="N1011E"></a><a name="How+to+Establish+your+Local+Repository"></a>
<h4>How to Establish your Local Repository</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -464,7 +470,7 @@
usual. Make some changes, re-build, and see the effect.
</p>
</div>
-<a name="N1014D"></a><a name="How+to+Keep+it+Up-to-date"></a>
+<a name="N10149"></a><a name="How+to+Keep+it+Up-to-date"></a>
<h4>How to Keep it Up-to-date</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -501,7 +507,7 @@
</ol>
</div>
-<a name="N1016D"></a><a name="How+to+Generate+Differences"></a>
+<a name="N10169"></a><a name="How+to+Generate+Differences"></a>
<h4>How to Generate Differences</h4>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -541,7 +547,7 @@
</ol>
</div>
-<a name="N10195"></a><a name="How+to+get+other+CVS+branches"></a>
+<a name="N10191"></a><a name="How+to+get+other+CVS+branches"></a>
<h4>How to get other CVS branches</h4>
<div style="margin-left: 0 ; border: 2px">
<p>OK that got the HEAD branch of CVS into your local working copy.
@@ -566,7 +572,7 @@
<a name="ssh"></a>
- <a name="N101B1"></a><a name="CVS+Committer+with+Secure+Shell+access"></a>
+ <a name="N101AD"></a><a name="CVS+Committer+with+Secure+Shell+access"></a>
<h3>CVS Committer with Secure Shell access</h3>
<div style="margin-left: 0 ; border: 2px">
<p>After a developer has consistently provided contributions (code,
@@ -598,9 +604,15 @@
<a name="procedure"></a>
- <a name="N101D3"></a><a name="Procedure+for+Raising+Development+Issues"></a>
+ <a name="N101CF"></a><a name="Procedure+for+Raising+Development+Issues"></a>
<h3>Procedure for Raising Development Issues</h3>
<div style="margin-left: 0 ; border: 2px">
+<p>Documentation contributions can usually be added directly to the
+ issue tracker. First read the
+ <a href="#contrib">contribution notes</a> above, then follow the
+ <a
href="http://cocoon.apache.org/2.1/howto/index.html#Contribution";>howto
documents</a>
+ about patching and about using Bugzilla.
+ </p>
<p>
There are two methods for discussing development and submitting patches.
So that everyone can be productive, it is important to know which method
@@ -608,7 +620,7 @@
confusion. This section explains when to use the
<span class="codefrag">cocoon-dev</span> <a
href="mail-lists.html">mailing list</a>
and when to use
- <a href="http://nagoya.apache.org/bugzilla/";>Bugzilla</a>
+ <a href="http://issues.apache.org/bugzilla/";>Bugzilla</a>
(the Apache Bug Database).
</p>
<p>
@@ -661,7 +673,7 @@
<a name="tips"></a>
- <a name="N1020C"></a><a name="Contribution+Notes+and+Tips"></a>
+ <a name="N10213"></a><a name="Contribution+Notes+and+Tips"></a>
<h3>Contribution Notes and Tips</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
