Changes between Version 11 and Version 12 of StartModPatchAndPullReq


Ignore:
Timestamp:
Nov 7, 2015, 2:07:50 PM (7 years ago)
Author:
Beman Dawes
Comment:

Add Drive-by Fixes section

Legend:

Unmodified
Added
Removed
Modified

  • StartModPatchAndPullReq

    v11 v12  
    9393}}}
    9494
     95== Avoid "Drive-by Fixes"
     96
     97A **drive-by fix** occurs when a patch fixing for the original problem also contains a fix for an unrelated problem. Drive-by fixes should be avoided because they entangle unrelated fixes in the same patch or pull request.
     98
     99 * The entire patch may be rejected or delayed because of a problem with one of the fixes.
     100 * If the patch is committed as submitted, the commit history may be muddied. This is made worse if the commit messages never mention the drive-by fix.
     101
     102Instead, please submit separate patches or pull requests for each problem. That allows a library maintainer to apply non-controversial patches right away while trying to resolve issues with patches that turn out to be controversial or are outright rejected. 
     103
    95104== Acknowledgements ==
    96105
    97106Sohail Somani suggested the topic, Nathan Crookston worked out the steps given in the example.
    98107Bjorn Reese suggested [http://lists.boost.org/Archives/boost/2014/03/212374.php some corrections].
     108Beman Dawes wrote the section on Drive-by fixes.