]> git.cworth.org Git - notmuch-wiki/commitdiff
patchformatting: Test Suite Enhancements
authorThomas Schwinge <thomas@schwinge.name>
Thu, 29 Sep 2011 18:19:15 +0000 (20:19 +0200)
committerThomas Schwinge <thomas@schwinge.name>
Thu, 29 Sep 2011 18:19:15 +0000 (20:19 +0200)
Based on the emails starting at
id:"87liu2kcq6.fsf@servo.factory.finestructure.net".

patchformatting.mdwn

index cf5bf813c082337c0e3f2799b3f12f1588ef184a..914371d4da071d916340c945304a26f02e06021c 100644 (file)
@@ -41,6 +41,16 @@ Eric S. Raymond has written good
 [Software Release Practice HOWTO](http://tldp.org/HOWTO/Software-Release-Practice-HOWTO/).
 Check what he has to say about this issue. 
 
+### Test Suite Enhancements
+
+New features as well as bug fixes should typically come with test suite
+enhancements.  The test suite changes should be done first (tagged as *expected
+to fail*), and the feature implementation or bug fix should come second
+(removing the *expected to fail* tag).  This way, the test suite specifies the
+behavior you're trying to implement, be it a new feature or a bug fix.  By
+defining beforehand exactly what you expect to happen, everyone can confirm
+that your patch achieves what it is meant it to.
+
 ## Prepare patches for e-mail submission
 
 If you've made just one commit (containing just one bugfix or new feature)