You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cocoon.apache.org by Robin Green <gr...@hotmail.com> on 2000/11/10 03:31:00 UTC

Fwd: Contribution system: cvs commit: xml-cocoon/xdocs 3rdparty.xml contrib.xml

As promised ages ago, I've been working on (well, typing up!) a simple 
contribution system so that contributions don't get forgotten about. I 
decided to handle patches differently from other contributions, for reasons 
given below. See CVS for full text. This is only an unfinished draft so it 
isn't linked into C1 build docs yet. Haven't done the patches page yet 
because I need sleep...

I knocked together the test policy and the legal policy based on what I 
remember of our discussions a while ago on this topic. Objections, anyone? 
These are not set it stone, they're just based on my recollections.

Important extracts:

>Delivered-To: mailing list cocoon-cvs@xml.apache.org
>Message-ID: <20...@locus.apache.org>
>
>greenrd     00/11/09 18:13:20
>
>   Modified:    xdocs    contrib.xml
>   Added:       xdocs    3rdparty.xml
>   Log:
>   Contrib system nearly ready!! comments on licensing policy welcomed
>
>   Revision  Changes    Path
>   1.2       +143 -7    xml-cocoon/xdocs/contrib.xml
>
>   Index: contrib.xml
>   ===================================================================
>   RCS file: /home/cvs/xml-cocoon/xdocs/contrib.xml,v
>   retrieving revision 1.1
>   retrieving revision 1.2
>   diff -u -r1.1 -r1.2
>   --- contrib.xml	2000/10/20 18:24:03	1.1
>   +++ contrib.xml	2000/11/10 02:13:19	1.2
>   @@ -4,17 +4,58 @@
>
>   +  <title>Making a Contribution to Apache Cocoon</title>

[snip]

>   + <s1 title="Contributions of Code and Documentation">
>   +  <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 
>Cocon (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 <connect 
>href="patches.xml">Patch management
>   +   </connect> page for more information.
>   +  </p>
>   +
>   +  <p>Otherwise (that is, if it does not require patching or you are not 
>particularly interested in
>   +   having it included in the main distribution), your code and/or
>   +   documentation can be listed on the
>   +   <connect href="3rdparty.xml">Third-Party Contributions</connect> 
>page.
>   +   The rationale for this split is that core patches may fix important 
>issues, and may
>   +   require timely attention if they are not to go
>   +   out-of-date and become useless, but other contributions can simply 
>be downloaded and
>   +   applied by users who wish to use them.
>   +  </p>
>   +
>   +  <p>A typical contribution (not a patch) may go through the following 
>stages:
>   +  <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 <code>contrib</code> 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>Inclusion into the main distribution. [Committers must be 
>confident that it should work properly in
>   +    most/all environments, and it must be considered sufficiently 
>useful and general to go into Cocoon. See also
>   +    Licensing Requirements below].</li>
>   +  </ol>
>   +
>   +  <s2 title="Testing Requirements for Cocoon Contrib and Distribution">
>   +   <note>These tests do not apply to Cocoon 2 because it is designed
>   +    to have different minimum requirements. As Cocoon 2 is still alpha 
>we are not at a rigourous
>   +    test stage yet. Stay tuned!</note>
>   +
>   +   <p>All new code should be tested under the following servlet 
>engines:</p>
>   +   <ul>
>   +    <li>Apache JServ 1.1.2 (NOTE: This uses Servlet API 2.0)</li>
>   +    <li>Apache Tomcat 3.1</li>
>   +    <li>Resin 1.2.0</li>
>   +   </ul>
>   +   <p>It should also be tested on the following:</p>
>   +   <ul>
>   +    <li>A Windows operating system</li>
>   +    <li>A UNIX-type operating system</li>
>   +    <li>A JDK version 1.1.x</li>
>   +   </ul>
>   +   <p>And obviously, it should be tested against the current CVS 
>snapshot of Cocoon!</p>
>   +
>   +   <p>This testing is designed to iron out the most common kinds of 
>incompatibilty
>   +    problems (Servlet >2.0 requirements; platform-dependent 
>assumptions; JDK >1.1 code).
>   +    These requirements are, of course, open to review and discussion. 
>Note that
>   +    the contributor is not required to do the testing - indeed it is 
>probably better
>   +    if someone else tests it, because the contributor might be tempted 
>to do less
>   +    than thorough testing!</p>
>   +  </s2>
>   +
>   + <s2 title="Licensing Requirements for the Cocoon Distribution">
>   +  <p>To avoid legal problems, the Apache Project Management Committe 
>(PMC) have agreed on
>   +   a policy for under what licensing code can be accepted into Apache 
>projects:</p>
>   +  <ul>
>   +   <ol>Source code files must be under the Apache license and must have 
>copyright assigned to
>   +    the Apache Software Foundation.</ol>
>   +   <ol>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).</ol>
>      </ul>
>   +  <p><strong>By submitting a patch, you signify your understanding and 
>acceptance of these
>   +   conditions</strong> - like most open source projects,
>   +   we do not have the resources nor the inclination to obtain signed 
>statements from all
>   +   contributors!</p>
>
>   -  <p></p>
>   +  <p><strong>Note:</strong> Since the <code>contrib/</code> directory 
>of Cocoon CVS contains
>   +   third-party. completely optional extensions, one of the above 
>requirements is relaxed.
>   +   Code in the contrib directory does not have to have its copyright 
>assigned to the ASF
>   +   - but it must still be released under the Apache license.</p>
>   + </s2>
>     </s1>
>    </body>
>    </document>

_________________________________________________________________________
Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com.

Share information about yourself, create your own public profile at 
http://profiles.msn.com.