[vlc-devel] [PATCH] Reverbation Files

jpd at videolan.org jpd at videolan.org
Tue Nov 24 14:49:57 CET 2009

> From ffa0d7f475e4d7797eee95f4834916d4a7601589 Mon Sep 17 00:00:00 2001
> From: richard <xwang at xwang-laptop.(none)>
> Date: Fri, 13 Nov 2009 14:57:35 +0800
> Subject: [PATCH] Reverbation Files
[text elided]

- No description as to what the patch does. We'd really like a nice
  commit message to go with it, so that anyone looking through git log
  gets an idea of what they're looking at.

- Your from address is bogus. Please fix. You're welcome to use git
  format-patch and send the patches with your regular mail client
  instead. But do make sure the patch contains the name you want
  credited for this work and a valid email address.

- New files need a GNU license heading.

- You seem to switch indentation between 2 and 8 spaces at random. Please
  use 4 spaces, no tabs, throughout.

- Why do you have separate setthis/setthat/init methods? It seems to me
  you're not actually using them more than once, so using the constructor
  would be more appropriate.

- Why do you create new objects on each pass through the worker? It seems
  to me that it would make more sense to set them up once and use them
  in each subsequent call to DoWork().

- Please do not write comments that state the obvious. If there are
  comments I'd like them to tell me something that is not immediately
  obvious from looking at the code, but that is important to know.

- The same principle applies to module descriptions. The description
  and longtext shouldn't be the same as the shortname. The text should
  be short but be intelligible for someone who did not write the code,
  in fact might not know about writing code at all. The text should
  help them answer questions like "how do I make this thing work?"

- Please do end your files with a newline.

More information about the vlc-devel mailing list