Developer Guide

Development Environment

The following list contains recommendations for a convenient DDS development environment:

POSIX oriented operating system (Mac OS X, Linux, ...)
git
Scala
SBT
Intellij + Scala plugin
Chrome (especially the developer tools)
Python + jsbeautifier (in case you want to automatically format your JavaScript code)

You do not have to use the stuff mentioned there but then things might not be as smooth as they could be .

Grab an issue (talk to @FRosner for suggestions)
Create an issue branch (git checkout -b issue/<issueNo>)
Develop your feature there
Rebase against master often (you can push a new branch for each rebase, e.g. issue/1337-2, issue/1337-3 etc.)
Once you are done, drop a message in the issue mentioning @FRosner and requesting a review (maybe create a pull request as well)
React to the reviewer comments and go back to 3. if needed
Wait for the branch to be merged

In order to add new visualizations to DDS, you have to do three major steps:

Provide a custom implementation of a Servable that stores the data to visualize [Scala]
Write one or multiple DDS core functions that send your Servable to the web server [Scala]
Tell main.js how to draw that servable [JavaScript]
Extend Visualization prototype and implement the draw and clean-up methods
Populate your custom visualization object inside main.js with the transmitted data from the servable