forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: rev 47081 - forrest/trunk/src/documentation/content/xdocs
Date Thu, 23 Sep 2004 04:51:02 GMT
Author: crossley
Date: Wed Sep 22 21:51:01 2004
New Revision: 47081

Modified:
   forrest/trunk/src/documentation/content/xdocs/contrib.xml
   forrest/trunk/src/documentation/content/xdocs/faq.xml
   forrest/trunk/src/documentation/content/xdocs/site.xml
Log:
Add notes about making patches and contributions.


Modified: forrest/trunk/src/documentation/content/xdocs/contrib.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/contrib.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/contrib.xml	Wed Sep 22 21:51:01 2004
@@ -17,10 +17,10 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
 <document>
   <header>
-    <title>Contributing to Forrest</title>
+    <title>Contributing to Apache Forrest</title>
   </header>
   <body>
-    <section>
+    <section id="introduction">
       <title>Introduction</title>
       <p> The Forrest Project is an <link href="http://www.opensource.org/">Open
Source</link> volunteer project released
       under a very liberal license. This means there are many ways to contribute to the
@@ -142,6 +142,33 @@
         enough and the readers eyes glazed over. </p>
     </section>
 
+    <section id="patch">
+     <title>How to prepare and contribute patches</title>
+     <p>If you use the current development version of Forrest, then do
+       '<code>svn update; svn status</code>' to see what files that you
+       have changed.
+       Do '<code>svn diff > mypatch.txt</code>' to make a patch which
+       includes every change. To make a patch for a specific file, do
+       <code>svn diff src/documentation/content/xdocs/faq.xml > faq.xml.diff</code>'.
+       For more information about working with SVN, see
+       <link href="http://svnbook.red-bean.com/">Version Control with
+       Subversion</link> - the opensource SVN book.
+      </p>
+      <p>If you use a downloaded released version of Forrest, then do
+        '<code>diff -u faq.xml.orig faq.xml > faq.xml.diff</code>'
+      </p>
+      <note>Please send all contributions via our
+        <link href="site:bugs">issue tracker</link>.
+      </note>
+      <p>
+        It is always a good idea to check the Forrest
+        <link href="site:bugs">issue tracker</link>
+        and 
+        <link href="site:todo">to do list</link>
+        before diving in.
+      </p>
+    </section>
+
     <section id="tips">
      <title>Contribution Notes and Tips</title>
       <p> This is a collection of tips for contributing to the project in a
@@ -162,7 +189,7 @@
           header). If so, then your new topic will get lost in the previous thread and go
           unanswered. </li>
         <li> Prepend your email subject line with a marker when that is
-          appropriate, e.g. <code>[Patch]</code>, <code>[Proposal]</code>,
+          appropriate, e.g. <code>[Proposal]</code>,
           <code>[RT]</code> (Random Thought which quickly blossom into research
topics
           :-), <code>[STATUS]</code> (development status of a certain facility).
</li>
         <li> When making changes to XML documentation, or any XML document for

Modified: forrest/trunk/src/documentation/content/xdocs/faq.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/faq.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/faq.xml	Wed Sep 22 21:51:01 2004
@@ -631,7 +631,7 @@
 
     <faq id="how_can_I_help">
       <question>
-        How can I help?
+        How to help?
       </question>
       <answer>
         <p>
@@ -642,11 +642,26 @@
           blinds software developers to faults that are obvious to everyone
           else. Don't be shy!
         </p>
-        <p>
-          More info about contributing can be found at the 
-          <link href="site:contrib">Contributing to Forrest</link> page.  Its
always
-          a good idea to check the Forrest <link href="site:todo">to do</link>
-          list before diving in.
+      </answer>
+    </faq>
+
+    <faq id="patch">
+      <question>
+        How to contribute a patch?
+      </question>
+      <answer>
+        <p>Please send all contributions via our
+          <link href="site:bugs">issue tracker</link>.
+          Here are notes about
+          <link href="site:contrib/patch">making patches</link>.
+        </p>
+        <p>More info about contributing can be found at the 
+          <link href="site:contrib">Contributing to Forrest</link> page.
+          It is always a good idea to check the Forrest
+          <link href="site:bugs">issue tracker</link>
+          and 
+          <link href="site:todo">to do list</link>
+          before diving in.
         </p>
       </answer>
     </faq>

Modified: forrest/trunk/src/documentation/content/xdocs/site.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/site.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/site.xml	Wed Sep 22 21:51:01 2004
@@ -137,7 +137,9 @@
 -->
   
   <getting-involved label="Getting Involved" tab="project">
-    <contrib label="Contributing" href="contrib.html"/>
+    <contrib label="Contributing" href="contrib.html">
+      <patch href="#patch"/>
+    </contrib>
     <build label="Building Forrest" href="build.html"/>
     <SVN label="Browse SVN" href="http://svn.apache.org/viewcvs.cgi/forrest/trunk/?root=Apache-SVN"/>
     <mail-lists label="Mail lists" href="mail-lists.html">

Mime
View raw message