[Yanel-commits] rev 56409 - public/yanel/trunk/src/realms/yanel-website/content

Mon Jan 31 19:17:21 CET 2011

Author: michi
Date: 2011-01-31 19:17:21 +0100 (Mon, 31 Jan 2011)
New Revision: 56409

Modified:
   public/yanel/trunk/src/realms/yanel-website/content/db90075e-74d0-4d8c-bdff-661e93af77cb
Log:
review checklist started

Modified: public/yanel/trunk/src/realms/yanel-website/content/db90075e-74d0-4d8c-bdff-661e93af77cb
===================================================================

--- public/yanel/trunk/src/realms/yanel-website/content/db90075e-74d0-4d8c-bdff-661e93af77cb	2011-01-31 16:52:37 UTC (rev 56408)
+++ public/yanel/trunk/src/realms/yanel-website/content/db90075e-74d0-4d8c-bdff-661e93af77cb	2011-01-31 18:17:21 UTC (rev 56409)
@@ -1,2 +1,42 @@
-<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml"><head>  <title>RTC (Review and Then Commit)</title>  <link rel="neutron-introspection" type="application/neutron+xml" href="?yanel.resource.usecase=introspection"/></head><body>  <h1>RTC (Review and Then Commit)</h1>  <ul><li>Download the patch from bugzilla<br/></li><li>Check the prefix of the files inside the patch</li><ul><li>The path should always be relative</li><li>The path should start at <a href="../../documentation/glossary.html#YANEL_HOME">YANEL_HOME</a></li></ul><li>NEVER EVER commit something without testing before and after</li><ul><li>Make sure that there are automatic tests, which are covering the changes which the patch will imply</li></ul><li>...</li></ul></body>
-</html>
\ No newline at end of file
+<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+  <title>RTC (Review and Then Commit)</title>
+  <link rel="neutron-introspection" type="application/neutron+xml" href="?yanel.resource.usecase=introspection"/>
+  </head>
+
+  <body>
+    <h1>RTC (Review and Then Commit)</h1>
+
+    <ul><li>Download the patch from bugzilla<br/></li><li>Check the prefix of the files inside the patch</li><ul><li>The path should always be relative</li><li>The path should start at <a href="../../documentation/glossary.html#YANEL_HOME">YANEL_HOME</a></li></ul>
+
+    <li>NEVER EVER commit something without testing before and after. Please use the following checklist:
+      <ul>
+        <li>Does it build?</li>
+        <li>Is the formatting correct?</li>
+        <li>Is there an automatic test? Make sure that there are automatic tests, which are covering the changes which the patch will imply.</li>
+        <li>Is it backwards compatible?</li>
+        <li>Does it scale/perform? (Can the implementation be changed?)</li>
+        <li>Can it be enhanced?</li>
+        <li>Can it be customized?</li>
+        <li>Does it work within a cluster?</li>
+        <li>Is it secure?</li>
+        <li>Can it be used offline?</li>
+        <li>Can the patch be reverted easily?</li>
+      </ul>
+    </li>
+    <li>Notify people via the mailing list and be prepared to revert the patch!</li>
+    </ul>
+
+<h2>Example:</h2>
+
+<p>Patch GenericExceptionHandler.java</p>
+
+<table>
+  <tr><th>Question></th><th>Answer</th></tr>
+  <tr><td>Does it build?</td><td>Yes</td></tr>
+  <tr><td>Is the formatting correct?</td><td>...</td></tr>
+  <tr><td>Does an automatic test exist?</td><td>No</td></tr>
+</table>
+
+  </body>
+</html>

