Re: comments, comments and comments

> I suggest that a message starts with the name of product like 
> 'CMFPlone: this little bug removed'. In fact you should describe all 
> changes in a particular commit as much as possible.

I've been developing software for 25 years, and I have a few guidelines 
I use:

- I always write code with the thought that someone else who has no 
connection with the project will have to read my code. This means lots 
of comments. My rule of thumb is, if I have to think about writing a 
line of code for more than a few seconds, it deserves a comment, 
because you need to reconstruct your line of thinking later.

- When commenting repository changes, if I am fixing a bug I say what 
method the bug was in and what was going wrong. If I add features, I 
say what methods I enhanced or added and what functionality was added.

Hope this helps.

Regards,

     Aparajita
     System Administrator
     Vasudeva Server


--------------------------------------------------------------------------
This message is sent to you because you are subscribed to the mailing list <VasudevaService-K9y3B4ipJAZZAIG4hdpdiNBPR1lH4CV8@public.gmane.org>.