Guild Builder Coding Style ========================== For the sake of uniformity and in the case of Python, valid syntax, this document outlines the standards we use in our code. It is important that all commits and patches follow this standard so our project reads easily and looks cohesive. If you have any questions regarding the standards, please direct them to the guildbuilder-devel mailing list at: guildbuilder-devel@lists.sourceforge.net Credits in Code --------------- Like the Django project, we do not want names or credits in individual files. These belong in the docs/credits file. Feel free to add your name there, but keep it out of the source. This may seem nitpicky but it's in the name of organization. Spaces and Tabs --------------- First and foremost, we do not use any tabs whatsoever in the source. Make sure you either configure your editor to use spaces instead of tabs, and indents are -four- (4) spaces. Not three, not two. Function Names -------------- We do not use camelcase. For example: someFunc() thisIsReallyUgly() We use underscores: some_func() this_is_really_ugly() Notice that nothing is capitalized. The only capitalization is for classes, whose first letters should be capitalized. Returns/Linebreaks ------------------ Make _sure_ you aren't saving in a DOS/Windows linebreak format. This really causes problems on Linux/Unix. Additionally, use returns liberally to improve readability. Chunks of logic should be seperated by returns.