Guidelines for committers

(Comment about this page to: bard?)

Note: you don't need to care about the following if you are just contributing patches. This only applies to those with write access to the repository.

The following is not necessarily the best style. However, it is the one the code is currently written in, so in the interest of presenting a coherent form to contributors, please adopt it for applications which are part of the SamePlace Suite.

  • no tabs
  • four indentation spaces
  • no brace delimiters for bodies of if, while, for etc. that are only one line long
  • functions under the appropriate source sections (e.g. GUI actions/reactions, utilities, etc., see the random development notes)
  • one blank line between a function definitions and the next one; two before section start
  • lowercase filenames with multiple words separated by underscores
  • single-line regular commit comments (extended commit comments can be multi-line)
  • if a patch resolves ticket 42 (in whole or in part), prefix the log message with RT#42
  • also prefix log message with the part of the system modified by the patch, e.g. "RT#42 TCP Transport: input stream would open buffered. Fixed."