vmassol 01/04/29 12:06:00
Modified: cactus/docs/framework/xdocs changes.xml doc-book.xml
site-book.xml todo.xml
Added: cactus/docs/framework/xdocs contributing.xml
Log:
new contributing web page that explains the different ways of contributing to Cactus
Revision Changes Path
1.16 +3 -0 jakarta-commons/cactus/docs/framework/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/cactus/docs/framework/xdocs/changes.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- changes.xml 2001/04/29 18:08:47 1.15
+++ changes.xml 2001/04/29 19:05:58 1.16
@@ -25,6 +25,9 @@
<release version="1.0 in CVS">
<action dev="VMA" type="add">
+ Added a contributing section that explains how to contribute to Cactus.
+ </action>
+ <action dev="VMA" type="add">
Added a license page on the Cactus web site that explains that Cactus
is under the APL license.
</action>
1.7 +1 -0 jakarta-commons/cactus/docs/framework/xdocs/doc-book.xml
Index: doc-book.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/cactus/docs/framework/xdocs/doc-book.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- doc-book.xml 2001/04/29 18:03:25 1.6
+++ doc-book.xml 2001/04/29 19:05:58 1.7
@@ -16,6 +16,7 @@
<menu-item type="changes" label="Changes" source="changes.xml"/>
<menu-item type="todo" label="Todo" source="todo.xml"/>
<menu-item label="Contributors" source="contributors.xml"/>
+ <menu-item label="Contributing" source="contributing.xml"/>
<menu-item label="License" source="license.xml"/>
<menu-item type="hidden" source="scope.xml" />
</menu>
1.7 +1 -0 jakarta-commons/cactus/docs/framework/xdocs/site-book.xml
Index: site-book.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/cactus/docs/framework/xdocs/site-book.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- site-book.xml 2001/04/29 18:03:25 1.6
+++ site-book.xml 2001/04/29 19:05:59 1.7
@@ -16,6 +16,7 @@
<menu-item type="changes" label="Changes" source="changes.xml"/>
<menu-item type="todo" label="Todo" source="todo.xml"/>
<menu-item label="Contributors" source="contributors.xml"/>
+ <menu-item label="Contributing" source="contributing.xml"/>
<menu-item label="License" source="license.xml"/>
<menu-item type="hidden" source="scope.xml" />
</menu>
1.17 +0 -4 jakarta-commons/cactus/docs/framework/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/cactus/docs/framework/xdocs/todo.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- todo.xml 2001/04/29 18:23:13 1.16
+++ todo.xml 2001/04/29 19:05:59 1.17
@@ -43,10 +43,6 @@
Handle <code>getRealPath()</code>, <code>getPathTranslated()</code> in the
<code>ServletRedirectorRequest</code> class.
</action>
- <action context="docs" assigned-to="VMA">
- Add a contributing section to the Cactus web site (see the contributing
- section of Cocoon as a sample).
- </action>
<action context="build" assigned-to="VMA">
On the documentation web pages (i.e. not the site web pages) add a sub
header for each page with a message saying "Click here if you want to
1.1 jakarta-commons/cactus/docs/framework/xdocs/contributing.xml
Index: contributing.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<document>
<header>
<title>Making a Contribution to Cactus</title>
<authors>
<person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>
The Cactus Project is an
<link href="http://www.opensource.org/";>Open Source</link>
volunteer project under the auspices of the
<link href="http://www.apache.org/";>Apache Software Foundation (ASF)</link>,
and, in harmony with the Apache webserver itself, it is released under
a very open license.
This means there are many ways to contribute to the project
(coding, documenting, answering questions,
proposing ideas, reporting bugs, suggesting bug-fixes, etc..).
</p>
<p>
To begin with, we suggest you to subscribe to the
<link href="mailto:[EMAIL PROTECTED]";>
Jakarta Commons mailing list</link>
(Indeed, Cactus is part of the Jakarta Commons project).
</p>
<note>
Any mail sent
on the <link href="mailto:[EMAIL PROTECTED]";>
Jakarta Commons</link> mailing list concerning Cactus should have it's
subject prefixed with <code>[cactus]</code> to differentiate it from
other emails sent for other components (Cactus is only one component of
Jakata Commons).
</note>
<p>
Then you can download the <link href="downloads.html">latest Cactus
release</link> or checkout the latest code from
<link href="http://jakarta.apache.org/cvsweb/index.cgi/jakarta-commons/cactus";>
CVS</link>.
</p>
<p>
Last, you can check the <link href="todo.html">todo list</link> and jump
in.
</p>
</s1>
<s1 title="Help Wanted Here">
<p>
The rest of this document is mainly about
contributing new or improved code and/or documentation, but we would also
be glad to have extra help in any of the following areas:
</p>
<ul>
<li>
Answering questions on the <code>jakarta-commons</code> mailing list -
there is often a problem of having too many questioners and not enough
experts to respond to all the questions.
</li>
<li>
Testing Cactus (especially its less-frequently-used features) on
various configurations and reporting back.
</li>
<li>
Debugging - producing reproducable test cases and/or finding causes of
bugs (bugs can be found in the
<link href="http://jakarta.apache.org/site/bugs.html";>
bug database</link>).
</li>
<li>
Specifying/analysing/designing new features for Cactus (If you wish to
get involved with this, please join
<code>[EMAIL PROTECTED]</code>),
install and try out Cactus and read some of the
<link
href="http://www.mail-archive.com/jakarta-commons%40jakarta.apache.org/";>
mail archives</link>.
</li>
<li>
Providing automated Ant scripts for new servlet engines/application
servers. The list of supported servers can found in the
<link href="features.html">features</link> list.
</li>
<li>
... and there is just one other thing - don't forget to tell everyone
who asks how great Cactus is! ;-)
The more people that know about and start to use Cactus, the larger the
pool of potential contributors there will be.
</li>
</ul>
<p>
Thank you very much.
</p>
</s1>
<s1 title="Contributions of Code and Documentation">
<p>
We are starting to use an informal system for accepting contributions to
Cactus. 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 Cactus
(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 Cactus
distribution, take note of the Licensing Requirements listed below, and
then post a message to the <code>jakarta-commons</code> mailing list with
<code>[cactus] [PATCH]</code> in the subject and include a
<code>diff</code> of your patch against the latest CVS version of the code.
</p>
<s2 title="Licensing Requirements for the Cocoon Distribution">
<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 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>
</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>
</s2>
</s1>
</body>
</document>
