For Developers

Versions

Scala 2.9.1
Akka 2.0.3
Config 0.5.0
SBT 0.13.0
Vaadin 6.7.6

Development Guidelines

• Use Scala formatter with default settings for all code.

• Before checkin

  • all code (core and ui) must compile

  • all unit tests must pass. In core run

      sbt 
      test-only com.persist.unit.*
    

• Things to (mostly) avoid

  • ; (semicolons)
  • var
  • return
  • waits
  • Java libraries (where there is a good Scala alternative)
  • semicolons (unless required)
  • null (use Option)
  • any concurrent access to mutable data
  • return

• Things to use

  • actors
  • immutable collection types

ScalaDoc

To generate Scala doc

cd core
sbt doc
open file core/target/scala-2.9.1/api/index.html

UI Testing

When developing UI code it is useful to add the following option to the browser URL.

?restartApplication

Local Directories

The .gitignore file includes directories with name local. These directories can be used to hold local files that are not to be included in the github repo.