Developer Guidelines

From Skycastle

For download and build instructions see Compiling Sources.

For used libraries and technologies see Design.

For information on joining the team see Join.

[edit] Code style

[edit] Formatting

• Opening brackets on new line
• Indent is four spaces.

[edit] API Documentation

• Document all public classes and methods with /** */ comments
• No author tags. Let's keep common code ownership, to ease development and maintenance without feeling like stepping into someone elses turf (if needed, the author information is available from the version control system).

[edit] Naming

• Use descriptive naming (but keep class names to one or two words where possible)
• Avoid one letter variables and parameters except for loops
• Avoid abbreviated names at all costs, except for very common terms ('URL', 'etc', etc)

[edit] Packaging

• One class or interface per file.
• Use packages to group classes in logical units.
• Have implementations in an 'impl' package under the package containing public API:s, where feasible.

[edit] Ordering

• Order of class members (roughly):
  1. public constants
  2. public fields
  3. private constants
  4. private fields
  5. public methods
  6. private methods
  7. inner classes

[edit] References

Good literature on successfully running and participating in F/OSS projects: Producing Open Source Software by Karl Fogel.