harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From apetre...@apache.org
Subject svn commit: r475182 - in /incubator/harmony/standard/site: docs/get-involved.html docs/guidelines.html docs/issue_resolution_guideline.html xdocs/get-involved.xml xdocs/guidelines.xml xdocs/issue_resolution_guideline.xml
Date Wed, 15 Nov 2006 10:30:53 GMT
Author: apetrenko
Date: Wed Nov 15 02:30:52 2006
New Revision: 475182

URL: http://svn.apache.org/viewvc?view=rev&rev=475182
Log:
Patch for HARMONY-2110 "Good issue resolution guideline"
"Good issue resolution guideline" has been linked to "Get involved"
Few typos are fixed

Modified:
    incubator/harmony/standard/site/docs/get-involved.html
    incubator/harmony/standard/site/docs/guidelines.html
    incubator/harmony/standard/site/docs/issue_resolution_guideline.html
    incubator/harmony/standard/site/xdocs/get-involved.xml
    incubator/harmony/standard/site/xdocs/guidelines.xml
    incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml

Modified: incubator/harmony/standard/site/docs/get-involved.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/get-involved.html?view=diff&rev=475182&r1=475181&r2=475182
==============================================================================
--- incubator/harmony/standard/site/docs/get-involved.html (original)
+++ incubator/harmony/standard/site/docs/get-involved.html Wed Nov 15 02:30:52 2006
@@ -36,7 +36,7 @@
             
             
             
-            <title>Apache Harmony - Apache Harmony</title>
+            <title>Apache Harmony - How do I contribute, give feedback, fix bugs and
so on?</title>
 
                                 <link rel="Stylesheet" type="text/css" href="site.css"/>
         </head>
@@ -236,6 +236,10 @@
        Bugs and other issues can be posted on the project
        <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>
     </li>
+  <li>Step-by-step instructions on reporting, resolving and closing issues are listed
in 
+  <a href="http://incubator.apache.org/harmony/issue_resolution_guideline.html">
+    Good Issue Resolution Guideline</a>
+  </li>
     <li>
       Additional documentation and discussion can be found on the project
      <a href="http://wiki.apache.org/harmony/">wiki</a>

Modified: incubator/harmony/standard/site/docs/guidelines.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/guidelines.html?view=diff&rev=475182&r1=475181&r2=475182
==============================================================================
--- incubator/harmony/standard/site/docs/guidelines.html (original)
+++ incubator/harmony/standard/site/docs/guidelines.html Wed Nov 15 02:30:52 2006
@@ -489,12 +489,16 @@
         </h1>
       </td></tr>
       <tr><td>
-                                    <p>Ideas must be review-then-commit; patches can
be commit-then-review.
-With a commit-then-review process, we trust that the developer doing the
-commit has a high degree of confidence in the change.  Doubtful changes,
-new features, and large-scale overhauls need to be discussed before
-being committed to a repository. Any major change 
-must receive consensus approval on the mailing list before being committed.
+                                    <p>
+  Ideas must be review-then-commit; patches can be commit-then-review.
+  With a commit-then-review process, we trust that the developer doing the
+  commit has a high degree of confidence in the change. Doubtful changes,
+  new features, and large-scale overhauls need to be discussed before
+  being committed to a repository. Any major change
+  must receive consensus approval on the mailing list before being committed.
+  For detailed instructions on reporting, resolving and closing issues, refer to
+  <a href="http://incubator.apache.org/harmony/issue_resolution_guideline.html">
+    Good Issue Resolution Guideline</a>. 
 </p>
                                                 <p>Each developer is responsible for
notifying the mailing list and 
 adding an action item to STATUS when they have an idea for a new feature 

Modified: incubator/harmony/standard/site/docs/issue_resolution_guideline.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/issue_resolution_guideline.html?view=diff&rev=475182&r1=475181&r2=475182
==============================================================================
--- incubator/harmony/standard/site/docs/issue_resolution_guideline.html (original)
+++ incubator/harmony/standard/site/docs/issue_resolution_guideline.html Wed Nov 15 02:30:52
2006
@@ -207,120 +207,114 @@
                                                                     <table  cellspacing="0"
cellpadding="2" width="100%">
       <tr><td>
         <h1>
-          <a name="Preface">Preface</a>
+          <a name="Good Issue Resolution Guideline">Good Issue Resolution Guideline</a>
         </h1>
       </td></tr>
       <tr><td>
                                     <p>
-        This guideline covers a wide range of issues but not all of them.
-        If you cannot do one of the steps, then write a comment to the issue.
+      This guideline provides step-by-step instructions on reporting, resolving 
+      and closing issues. If you cannot do one of the steps, then write a comment to the
issue.
     </p>
-                                                <p>
-        Use your common sense!
-    </p>
-                           
-      </td></tr>
-    </table>
-    <p><a href="#top">Back to top</a></p>
-                                                <table  cellspacing="0" cellpadding="2"
width="100%">
+                                                    
       <tr><td>
-        <h1>
-          <a name="Issue reporter">Issue reporter</a>
-        </h1>
+            <h2>
+          <a name="Reporting Issues">Reporting Issues</a>
+            </h2>
       </td></tr>
       <tr><td>
-                                    <p>
-    <ol>
-        <li>Explicitly state the expected behavior and the</li>
-            actual behavior of Harmony code. Use links to specs, rfcs, etc.
-        <li>Try to create as small test case as possible. A patch
-            to test will be highly appreciated.</li>
-        <li>Provide max. information about steps necessary to recreate the bug.
+        
+                                    <ol>
+        <li>State the expected behavior and the
+            actual behavior of Harmony code explicitly. Use links to 
+            specifications, references, etc.</li>
+        <li>Create a test case as small as possible. A patch
+            to test is highly appreciated.</li>
+        <li>Provide maximum information about steps necessary to reproduce the bug.
             If a patch for the test has not been supplied, provide as much
-            diagnostic information about the failure as possible (stack trace,
-            failure output, expected output etc).</li>
-        <li>Remember to use issue links if applicable.</li>
-        <li>Check the issue resolution when it is committed. Add a comment.</li>
+            diagnostic information about the failure as possible: stack trace,
+            failure output, expected output, etc.</li>
+        <li>Use issue links if applicable.</li>
+        <li>Check the issue resolution, when it is committed. Add a comment.</li>
     </ol>
-    </p>
-                           
-      </td></tr>
-    </table>
-    <p><a href="#top">Back to top</a></p>
-                                                <table  cellspacing="0" cellpadding="2"
width="100%">
-      <tr><td>
-        <h1>
-          <a name="Resolution provider :)">Resolution provider :)</a>
-        </h1>
+                            
       </td></tr>
+       
+                                                    
       <tr><td>
-                                    <p>
-        Depending on the type of issue, do the following:
-    <ol>
-        <li>
-            Issue is probably a non-bug difference, not a bug or invalid:
-            <ol>
-                <li>Discuss on the dev list.</li>
-                <li>Add a link to the discussion thread as a comment to issue.</li>
+            <h2>
+          <a name="Resolving Issues">Resolving Issues</a>
+            </h2>
+      </td></tr>
+      <tr><td>
+        
+                                    <p>To resolve an issue, define its type first.</p>
+                                                <p>   
+            If <i>the issue is a non-bug difference, not a bug or invalid</i>,
+            you should do the following:</p>
+                                                <ol>
+                <li>Discuss the issue on the 
+                <a href="mailing.html">developer mailing list</a>.</li>
+                <li>Add a link to the discussion thread as a comment to the issue.</li>
             </ol>
-        </li>
-        <li>
-            Issue is a bug:
-            <ol>
-                <li>Notify the community that you started investigation by adding
-                a comment to the issue and send a message to dev list. If you cannot
-                produce a patch, add another comment with the results of your investigation.</li>
+                                                <p>If <i>the issue is a bug</i>,
you should do the following:</p>
+                                                <ol>
+                <li>
+                  Notify the community that you started investigation by adding
+                  a comment to the issue and send a message to the 
+                  <a href="mailing.html">developer mailing list</a>.
+                  If you cannot create a patch, add another comment with your 
+                  investigation results.</li>
                 <li>If reporter did not provide a patch to test:
-                    <ol>
+                    <ul>
                         <li>Try to create a patch to test.</li>
-                        <li>If you cannot produce a patch, write a comment about it.</li>
-                    </ol>
+                        <li>If you cannot create a patch, write a comment about it.</li>
+                    </ul>
                 </li>
-                <li>Create a patch to fix the issue. Any concerns? Discuss on the dev
list. 
-                Add a link to discussion as a comment.</li>
-                <li>All the pacthes (test and fix) should be relative to the directory
where 
-                the main build.xml is: https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk.
-                Or to the module root directory.</li>
+                <li>
+                  Create a patch to fix the issue. If you have any questions,
+                  discuss them on the <a href="mailing.html">developer mailing list</a>.
+                  Add a link to the discussion as a comment.</li>
+                <li>All pacthes, such as tests and fixes, should be relative to the
directory where 
+                the main <code>build.xml</code> is:<br />
+                <code>https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk</code>,<br
/>
+                or to the module root directory.</li>
                 <li>Test and fix patches should be in different files.</li>
-                <li>If the patch requires to add, remove or move some files in the
repository, add the appropriate script.</li>
+                <li>If the patch requires adding, removing or moving some files in
the repository, 
+                provide the appropriate script.</li>
                 <li>Check that all unit tests pass.</li>
-                <li>If it is an application-oriented issue, check the application.</li>
-                <li>Remember to use issue links if applicable.</li>
+                <li>If the issue is application-oriented, check the application.</li>
+                <li>Use issue links if applicable.</li>
             </ol>
-        </li>
-    </ol>
-    </p>
-                           
+                            
       </td></tr>
-    </table>
-    <p><a href="#top">Back to top</a></p>
-                                                <table  cellspacing="0" cellpadding="2"
width="100%">
+       
+                                                    
       <tr><td>
-        <h1>
-          <a name="Committer">Committer</a>
-        </h1>
+            <h2>
+          <a name="Closing Issues">Closing Issues</a>
+            </h2>
       </td></tr>
       <tr><td>
-                                    <p>
-        Depending on the issue type, do:
-        <ol>
-            <li>Issue is a non-bug difference, not a bug or invalid: close the issue.</li>
-            <li>Issue is a bug:
-                <ol>
+        
+                                    <p>To close an issue, define its type first.</p>
+                                                <p>
+       If <i>the issue is a non-bug difference, not a bug or invalid</i>, you
should close the issue.</p>
+                                                <p>If <i>the issue is a bug</i>,
you should do the following: </p>
+                                                <ol>
                     <li>If a patch to test is available, apply it.</li>
                     <li>Check that the test fails.</li>
                     <li>Apply the fix for the issue.</li>
                     <li>Check that test succeeds now.</li>
                     <li>Make sure that all unit tests pass.</li>
                     <li>For application-oriented issues, check the application.</li>
-                    <li>If there are problems on previous steps, post a comment to
-                    JIRA and let "resolution provider" to resolve.</li>
+                    <li>If there are any problems on previous steps, post a comment
to
+                    JIRA and let "resolution provider" resolve them.</li>
                     <li>Make sure that the issue reporter is happy with the resolution.</li>
-                    <li>Add revision info into JIRA issue.</li>
+                    <li>Add revision info into the JIRA issue.</li>
                 </ol>
-            </li>
-        </ol>
-    </p>
+                            
+      </td></tr>
+       
                            
       </td></tr>
     </table>

Modified: incubator/harmony/standard/site/xdocs/get-involved.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/get-involved.xml?view=diff&rev=475182&r1=475181&r2=475182
==============================================================================
--- incubator/harmony/standard/site/xdocs/get-involved.xml (original)
+++ incubator/harmony/standard/site/xdocs/get-involved.xml Wed Nov 15 02:30:52 2006
@@ -3,7 +3,7 @@
 <document>
 
  <properties>
-  <title>Apache Harmony</title>
+  <title>How do I contribute, give feedback, fix bugs and so on?</title>
   <author email="harmony-dev@harmony.apache.org">Harmony Documentation Team</author>
  </properties>
 
@@ -38,6 +38,10 @@
        Bugs and other issues can be posted on the project
        <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>
     </li>
+  <li>Step-by-step instructions on reporting, resolving and closing issues are listed
in 
+  <a href="http://incubator.apache.org/harmony/issue_resolution_guideline.html">
+    Good Issue Resolution Guideline</a>
+  </li>
     <li>
       Additional documentation and discussion can be found on the project
      <a href="http://wiki.apache.org/harmony/">wiki</a>

Modified: incubator/harmony/standard/site/xdocs/guidelines.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/guidelines.xml?view=diff&rev=475182&r1=475181&r2=475182
==============================================================================
--- incubator/harmony/standard/site/xdocs/guidelines.xml (original)
+++ incubator/harmony/standard/site/xdocs/guidelines.xml Wed Nov 15 02:30:52 2006
@@ -278,12 +278,16 @@
 
 <section name="When to Commit a Change">
 
-<p>Ideas must be review-then-commit; patches can be commit-then-review.
-With a commit-then-review process, we trust that the developer doing the
-commit has a high degree of confidence in the change.  Doubtful changes,
-new features, and large-scale overhauls need to be discussed before
-being committed to a repository. Any major change 
-must receive consensus approval on the mailing list before being committed.
+<p>
+  Ideas must be review-then-commit; patches can be commit-then-review.
+  With a commit-then-review process, we trust that the developer doing the
+  commit has a high degree of confidence in the change. Doubtful changes,
+  new features, and large-scale overhauls need to be discussed before
+  being committed to a repository. Any major change
+  must receive consensus approval on the mailing list before being committed.
+  For detailed instructions on reporting, resolving and closing issues, refer to
+  <a href="http://incubator.apache.org/harmony/issue_resolution_guideline.html">
+    Good Issue Resolution Guideline</a>. 
 </p>
 
 <p>Each developer is responsible for notifying the mailing list and 

Modified: incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml?view=diff&rev=475182&r1=475181&r2=475182
==============================================================================
--- incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml (original)
+++ incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml Wed Nov 15 02:30:52
2006
@@ -26,78 +26,78 @@
 
 <body>
 
-	<section name="Preface">
+	<section name="Good Issue Resolution Guideline">
     <p>
-        This guideline covers a wide range of issues but not all of them.
-        If you cannot do one of the steps, then write a comment to the issue.
+      This guideline provides step-by-step instructions on reporting, resolving 
+      and closing issues. If you cannot do one of the steps, then write a comment to the
issue.
     </p>
-    <p>
-        Use your common sense!
-    </p>
-    </section>
+       
+    <subsection name="Reporting Issues">
     
-    <section name="Issue reporter">
-    <p>
     <ol>
-        <li>Explicitly state the expected behavior and the</li>
-            actual behavior of Harmony code. Use links to specs, rfcs, etc.
-        <li>Try to create as small test case as possible. A patch
-            to test will be highly appreciated.</li>
-        <li>Provide max. information about steps necessary to recreate the bug.
+        <li>State the expected behavior and the
+            actual behavior of Harmony code explicitly. Use links to 
+            specifications, references, etc.</li>
+        <li>Create a test case as small as possible. A patch
+            to test is highly appreciated.</li>
+        <li>Provide maximum information about steps necessary to reproduce the bug.
             If a patch for the test has not been supplied, provide as much
-            diagnostic information about the failure as possible (stack trace,
-            failure output, expected output etc).</li>
-        <li>Remember to use issue links if applicable.</li>
-        <li>Check the issue resolution when it is committed. Add a comment.</li>
+            diagnostic information about the failure as possible: stack trace,
+            failure output, expected output, etc.</li>
+        <li>Use issue links if applicable.</li>
+        <li>Check the issue resolution, when it is committed. Add a comment.</li>
     </ol>
-    </p>
-    </section>
+   
+    </subsection>
 
-    <section name="Resolution provider :)">
-    <p>
-        Depending on the type of issue, do the following:
-    <ol>
-        <li>
-            Issue is probably a non-bug difference, not a bug or invalid:
+    <subsection name="Resolving Issues">
+      <p>To resolve an issue, define its type first.</p>
+    <p>   
+            If <i>the issue is a non-bug difference, not a bug or invalid</i>,
+            you should do the following:</p>
             <ol>
-                <li>Discuss on the dev list.</li>
-                <li>Add a link to the discussion thread as a comment to issue.</li>
+                <li>Discuss the issue on the 
+                <a href="mailing.html">developer mailing list</a>.</li>
+                <li>Add a link to the discussion thread as a comment to the issue.</li>
             </ol>
-        </li>
-        <li>
-            Issue is a bug:
+        
+       <p>If <i>the issue is a bug</i>, you should do the following:</p>:
             <ol>
-                <li>Notify the community that you started investigation by adding
-                a comment to the issue and send a message to dev list. If you cannot
-                produce a patch, add another comment with the results of your investigation.</li>
+                <li>
+                  Notify the community that you started investigation by adding
+                  a comment to the issue and send a message to the 
+                  <a href="mailing.html">developer mailing list</a>.
+                  If you cannot create a patch, add another comment with your 
+                  investigation results.</li>
                 <li>If reporter did not provide a patch to test:
-                    <ol>
+                    <ul>
                         <li>Try to create a patch to test.</li>
-                        <li>If you cannot produce a patch, write a comment about it.</li>
-                    </ol>
+                        <li>If you cannot create a patch, write a comment about it.</li>
+                    </ul>
                 </li>
-                <li>Create a patch to fix the issue. Any concerns? Discuss on the dev
list. 
-                Add a link to discussion as a comment.</li>
-                <li>All the pacthes (test and fix) should be relative to the directory
where 
-                the main build.xml is: https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk.
-                Or to the module root directory.</li>
+                <li>
+                  Create a patch to fix the issue. If you have any questions,
+                  discuss them on the <a href="mailing.html">developer mailing list</a>.
+                  Add a link to the discussion as a comment.</li>
+                <li>All pacthes, such as tests and fixes, should be relative to the
directory where 
+                the main <code>build.xml</code> is:<br/>
+                <code>https://svn.apache.org/repos/asf/incubator/harmony/enhanced/classlib/trunk</code>,<br/>
+                or to the module root directory.</li>
                 <li>Test and fix patches should be in different files.</li>
-                <li>If the patch requires to add, remove or move some files in the
repository, add the appropriate script.</li>
+                <li>If the patch requires adding, removing or moving some files in
the repository, 
+                provide the appropriate script.</li>
                 <li>Check that all unit tests pass.</li>
-                <li>If it is an application-oriented issue, check the application.</li>
-                <li>Remember to use issue links if applicable.</li>
+                <li>If the issue is application-oriented, check the application.</li>
+                <li>Use issue links if applicable.</li>
             </ol>
-        </li>
-    </ol>
-    </p>
-    </section>
+      
+    </subsection>
 
-    <section name="Committer">
+    <subsection name="Closing Issues">
+      <p>To close an issue, define its type first.</p>
     <p>
-        Depending on the issue type, do:
-        <ol>
-            <li>Issue is a non-bug difference, not a bug or invalid: close the issue.</li>
-            <li>Issue is a bug:
+       If <i>the issue is a non-bug difference, not a bug or invalid</i>, you
should close the issue.</p>
+            <p>If <i>the issue is a bug</i>, you should do the following:
</p>
                 <ol>
                     <li>If a patch to test is available, apply it.</li>
                     <li>Check that the test fails.</li>
@@ -105,14 +105,13 @@
                     <li>Check that test succeeds now.</li>
                     <li>Make sure that all unit tests pass.</li>
                     <li>For application-oriented issues, check the application.</li>
-                    <li>If there are problems on previous steps, post a comment to
-                    JIRA and let "resolution provider" to resolve.</li>
+                    <li>If there are any problems on previous steps, post a comment
to
+                    JIRA and let "resolution provider" resolve them.</li>
                     <li>Make sure that the issue reporter is happy with the resolution.</li>
-                    <li>Add revision info into JIRA issue.</li>
+                    <li>Add revision info into the JIRA issue.</li>
                 </ol>
-            </li>
-        </ol>
-    </p>
-    </section>
+         
+    </subsection>
+  </section>
 </body>
-</document>
\ No newline at end of file
+</document>



Mime
View raw message