Changes between Version 3 and Version 4 of WorkingConventions/Submissions


Ignore:
Timestamp:
Sep 11, 2007 12:09:19 PM (7 years ago)
Author:
simonmar
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions/Submissions

    v3 v4  
    1515 * Follow our convention for naming patches: [wiki:WorkingConventions/Darcs#PatchNaming]. 
    1616 
    17  * Comment your fix in the source code.  It is often helpful to give a small example code fragment that demonstrates the need for your fix.  This isn't always relevant; sometimes you are fixing a plain error, but often it's more subtle than that. 
     17 * Comment your fix in the source code, and include a reference to the bug ticket number, e.g. "`#1466`" (this helps when grepping for the fix later).  It is often helpful to give a small example code fragment that demonstrates the need for your fix.  This isn't always relevant; sometimes you are fixing a plain error, but often it's more subtle than that. 
    1818 
    1919 * Please ensure that there is a test case in the [wiki:Building/RunningTests regression-test suite] that shows up the bug, and which is fixed by your patch.  This test case should be identified in the "Test Case" field of the Trac report.