You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by ap...@apache.org on 2006/11/07 11:25:08 UTC
svn commit: r472055 - in /incubator/harmony/standard/site:
docs/issue_resolution_guideline.html xdocs/issue_resolution_guideline.xml
Author: apetrenko
Date: Tue Nov 7 02:25:07 2006
New Revision: 472055
URL: http://svn.apache.org/viewvc?view=rev&rev=472055
Log:
Good issue resolution guideline
Added:
incubator/harmony/standard/site/docs/issue_resolution_guideline.html
incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml
Added: 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=auto&rev=472055
==============================================================================
--- incubator/harmony/standard/site/docs/issue_resolution_guideline.html (added)
+++ incubator/harmony/standard/site/docs/issue_resolution_guideline.html Tue Nov 7 02:25:07 2006
@@ -0,0 +1,366 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="Harmony Documentation Team">
+ <meta name="email" value="harmony-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache Harmony - Good Issue Resolution Guideline</title>
+
+ <link rel="Stylesheet" type="text/css" href="site.css"/>
+ </head>
+
+ <body>
+ <table width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <table><tr><td>
+ <td>
+<a href="http://incubator.apache.org/harmony/"><img src="./images/harmony-logo.png" alt="Apache Harmony" /></a>
+</td>
+</td>
+ </td></tr></table>
+ </td>
+ <td align='RIGHT'>
+ <a href="http://incubator.apache.org/harmony/">
+ <img src="http://incubator.apache.org/harmony/images/apache-incubator-logo.png"
+ alt="Apache Harmony" /></a>
+ </td>
+ </tr>
+ </table>
+ <table width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td class="menuItem" width="20%" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://www.us.apachecon.com/">
+ <img src="http://www.apache.org/ads/ApacheCon/240x120-2006-us.gif"
+ alt="ApacheCon US 2006" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p class="menuItem"><strong>General</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="./index.html">Home</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./license.html">License</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./contribution_policy.html">Contribution Policy</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./guidelines.html">Project Guidelines</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="http://www.apache.org/">ASF</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./downloads.html">Downloads</a>
+</li>
+
+
+
+ </ul>
+ <p class="menuItem"><strong>Community</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="./get-involved.html">Get Involved</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./contributors.html">Committers</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./mailing.html">Mailing Lists</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./documentation/documentation.html">Documentation</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./faq.html">FAQ</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="http://wiki.apache.org/harmony">Wiki</a>
+</li>
+
+
+
+ </ul>
+ <p class="menuItem"><strong>Development</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="./status.html">How Are We Doing?</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./roadmap.html">Road Map / TODO</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./svn.html">Source Code</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./related.html">Other Projects</a>
+</li>
+
+
+
+ </ul>
+ <p class="menuItem"><strong>Subcomponents</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="./subcomponents/buildtest/index.html">Build-Test Framework</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./subcomponents/classlibrary/index.html">Class Library</a>
+</li>
+
+
+ <table>
+ <tr><td class="menuItem">
+ <a href="./subcomponents/classlibrary/status.html">Status</a>
+ </td></tr>
+ </table>
+
+ <li class="menuItem"> <a href="./subcomponents/drlvm/index.html">DRLVM</a>
+</li>
+
+
+
+ <li class="menuItem"> <a href="./subcomponents/jchevm/index.html">JCHEVM</a>
+</li>
+
+
+
+ </ul>
+ </td>
+ <td width="80%" valign="top"><a name="top"></a>
+ <table cellspacing="0" cellpadding="2" width="100%">
+ <tr><td>
+ <h1>
+ <a name="Preface">Preface</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.
+ </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>
+ </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.
+ 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>
+ </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>
+ </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>
+ <li>If reporter did not provide a patch to test:
+ <ol>
+ <li>Try to create a patch to test.</li>
+ <li>If you cannot produce a patch, write a comment about it.</li>
+ </ol>
+ </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>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>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>
+ </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>
+ </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>
+ <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>Make sure that the issue reporter is happy with the resolution.</li>
+ <li>Add revision info into JIRA issue.</li>
+ </ol>
+ </li>
+ </ol>
+ </p>
+
+ </td></tr>
+ </table>
+ <p><a href="#top">Back to top</a></p>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div class="special"><em>
+ Copyright © 2003-2006, The Apache Software Foundation
+ </em></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Added: 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=auto&rev=472055
==============================================================================
--- incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml (added)
+++ incubator/harmony/standard/site/xdocs/issue_resolution_guideline.xml Tue Nov 7 02:25:07 2006
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<document>
+
+<properties>
+ <title>Good Issue Resolution Guideline</title>
+ <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+</properties>
+
+<body>
+
+ <section name="Preface">
+ <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.
+ </p>
+ <p>
+ Use your common sense!
+ </p>
+ </section>
+
+ <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.
+ 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>
+ </ol>
+ </p>
+ </section>
+
+ <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:
+ <ol>
+ <li>Discuss on the dev list.</li>
+ <li>Add a link to the discussion thread as a comment to 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>
+ <li>If reporter did not provide a patch to test:
+ <ol>
+ <li>Try to create a patch to test.</li>
+ <li>If you cannot produce a patch, write a comment about it.</li>
+ </ol>
+ </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>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>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>
+ </ol>
+ </li>
+ </ol>
+ </p>
+ </section>
+
+ <section name="Committer">
+ <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>
+ <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>Make sure that the issue reporter is happy with the resolution.</li>
+ <li>Add revision info into JIRA issue.</li>
+ </ol>
+ </li>
+ </ol>
+ </p>
+ </section>
+</body>
+</document>
\ No newline at end of file