[dmd-internals] Pull request style

[Walter Bright]

First off, thanks to everyone who is doing pull requests. This is a great help!

I'm spamming all three lists, because I think this is general and helpful.

1. Commit messages:

Please, please, PLEASE when a pull request fixes a bugzilla issue, use this as 
the first line of the commit message:

     fix Issue 5412 - import wtf2

Note that everything after the string "fix" is cut & pasted from the bugzilla title:

    http://d.puremagic.com/issues/show_bug.cgi?id=5412

Easy as pie. Doing it this way means that bugzilla and github automatically talk 
to each other about the fix. It makes life easier for the poor sod trying to 
keep the cross references up to date, give proper credit to the submitter, etc.

It is not necessary to invent a new convention for this. Please don't.


2. The pull request often comes with a nice and lucid explanation about the fix, 
oddities about it, etc. But then the actual code patch has no comments at all. 
The code is where the explanation of how the fix works goes. It's nice to have 
it in the pull request too, but please cut&paste it into a comment in the right 
place in the code. If there's a long-winded discussion in bugzilla or the n.g. 
about how things should work, it can be nice to put a link to that discussion in 
the comments.


3. Please do not combine independent fixes into one pull request. Each fix 
should live in its own pull request. The problem with combining them is it's a 
darn nuisance if one of them isn't right.


4. It's nice if, in the pull request message, provide a link to the bugzilla 
entry it addresses. This makes it quick&easy for me to see what's up with the 
bug report.


5. You guys have been great about including test cases that verify the fix. 
Please continue!
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puremagic.com/pipermail/dmd-internals/attachments/20120218/9c8ef0b0/attachment.html>