Added text about patch formatting
authorNick Dokos <nicholas.dokos@hp.com>
Thu, 5 May 2011 19:29:10 +0000 (15:29 -0400)
committerNick Dokos <nicholas.dokos@hp.com>
Thu, 5 May 2011 19:29:10 +0000 (15:29 -0400)
org-contribute.org

index 1a9ebea..e01511e 100644 (file)
@@ -91,9 +91,20 @@ provides an amazing framework to collaborate on a project.  Git can be used
 to make patches and send them via email -- this is perfectly fine for minor
 changes.
 
-These patches will be automatically registered at [[http://patchwork.newartisans.com/project/org-mode][John Wiegley's patchwork
-server]] and will then be accepted, rejected, or sent back to the author with
-a request for modification.
+As long as these patches are formatted properly, they will be
+automatically registered at [[http://patchwork.newartisans.com/project/org-mode][John Wiegley's patchwork server]] and will
+then be accepted, rejected, or sent back to the author with a request
+for modification. In this context, "formatted properly" means that the
+patches are included either plainly in the mail text, or as text
+attachments (mime-type text, subtypes "x-patch", "x-diff", or
+"plain"). In particular, binary types or, even worse,
+"application/octet-stream" (the asinine default of some mail programs,
+e.g. Thunderbird) are *not* going to be recognized. Please find out
+how to convince your mail program to send proper attachments. Also, if
+you include the patch inline, please make sure that your mail program
+does not reformat it (although there are plenty of places further down
+the line where that can happen, unfortunately). If you attach the
+patch, then reformatting is not a problem.
 
 ** Sending quick fixes