vmassol 2004/03/11 02:19:21
Modified: documentation/docs/xdocs sitemap.xml
documentation/docs/xdocs/participating
coding_conventions.xml
Log:
document the fact that we do not want to use @author tags anymore in source code.
Revision Changes Path
1.71 +1 -0 jakarta-cactus/documentation/docs/xdocs/sitemap.xml
Index: sitemap.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/documentation/docs/xdocs/sitemap.xml,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -r1.70 -r1.71
--- sitemap.xml 11 Mar 2004 08:05:53 -0000 1.70
+++ sitemap.xml 11 Mar 2004 10:19:21 -0000 1.71
@@ -388,6 +388,7 @@
<external id="anthill" url="http://www.urbancode.com/projects/anthill/"/>
<external id="antlr" url="http://antlr.org/"/>
<external id="apache" url="http://www.apache.org/"/>
+ <external id="apache_no_author_tags"
url="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=107788069123268&w=2"/>
<external id="aspectj" url="http://www.eclipse.org/aspectj/"/>
<external id="australian_slang"
url="http://www.koalanet.com.au/australian-slang.html#C"/>
<external id="blog_vmassol" url="http://blogs.codehaus.org/people/vmassol/"/>
1.5 +11 -8
jakarta-cactus/documentation/docs/xdocs/participating/coding_conventions.xml
Index: coding_conventions.xml
===================================================================
RCS file:
/home/cvs/jakarta-cactus/documentation/docs/xdocs/participating/coding_conventions.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- coding_conventions.xml 13 Jul 2003 10:05:51 -0000 1.4
+++ coding_conventions.xml 11 Mar 2004 10:19:21 -0000 1.5
@@ -167,14 +167,17 @@
<section title="6. Author references">
<p>
- If you contribute to a file (code or documentation), add yourself to
- the top of the file (below the existing authors). For java files the
- preferred Javadoc format is:
+ Do not put <code>@author</code> tags in source code. We are following
+ the Apache board recommendation. This view is
+ <a href="ext:apache_no_author_tags">summarized</a> nicely
+ by Dirk-Willem Van Gullick, president of the ASF.
+ </p>
+ <p>
+ However you are very much encouraged to edit the
+ <code>contributors.xml</code> file located in
+ <code>jakarta-cactus/documentation/docs/xdocs/participating/</code>
+ which lists contributors' participation.
</p>
-
-<source><![CDATA[
[EMAIL PROTECTED] <a href="mailto:[EMAIL PROTECTED]">John Doe</a>
-]]></source>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]