Front page | perl.perl5.porters |
Postings from January 2010
> Just to explain, a one line or small patch may actually need several > paragraphs of explanation. Putting those paragraphs in the code can > lead to code that is so obfuscated by comments that it is > unmaintainable. A small comment indicating that a fuller explanation > is in the commit message to me seems like a good balance. > > The larger the patch the more reasonable it is that it includes > internal commentary independent of the commit message, and that > correspondingly that commit messages for large patches can be less > explanatory than small ones. > > A large patch adding multiple functions, tests and etc, is essentially > self documenting and might justify a commit message like "Add new > regex logic for char classes", whereas a oneliner commit almost > always, typo fixes aside, deserves at least a paragraph why it is > being changed. > > My opinion only btw. Im not trying to say this should be policy or anything. > Thanks. I added something of this sentiment to the pod. > Cheers, > Yves > > > > > > -- > perl -Mre=debug -e "/just|another|perl|hacker/" > --Thread Previous | Thread Next