On Aug 19, 2010, at 11:43 AM, Mattmann, Chris A (388J) wrote: > Hey Kevan, > > Thanks! My comments below: > >>> Just wanted to give you a heads up. In my wrapping up of SIS-3, I've >>> committed some contributed code from Nga Chung, a student from my CSCI 572 >>> Search Engines and Information Retrieval class at USC this past semester, >>> Summer 2010. >> >> Thanks Nga! A few procedural notes: >> >> 1) If Nga wrote/contributed the code, she should be acknowledged in the svn >> commit message > > I acknowledged her in CHANGES.txt (see r986558 [1]), as well as in JIRA (see > [2]). I think that's sufficient. Some projects like to acknowledge in SVN > too, but I normally just say "fix for JIRA-ISSUE-xxx <short title>" in my > SVN commits and acknowledge in JIRA resolve message and in CHANGES.txt, and > I'm consistent about it.
I overstated. And you are right that this is project specific. So, IMO, the good thing about the acknowledgement in the commit message is that it is preserved in svn history. So, 5 years from now, someone could understand that this code was created by Nga, not some guy named Chris. CHANGES.txt may disappear. Indirect references via Jira numbers are very difficult to follow. svn log should be around for a long time... --kevan
