2.0.0 Developers Guide

Welcome developers! This is a quick and simple guide to aid new developers who are just getting started with Vireo.

Play 1.2.5 Documentation
Spring Documentation
JPA Documentation from ObjectDB. We don't use this JPA implementation but there web-based documentation is great is mostly applicable for our Hibernate implementation.

Eclipse or Netbeans

Some developers use Eclipse, others use Netbeans, Vireo works fine with either. You should know about the play eclipsify or play netbeansify. These play commands will
Play Test

While developing you probably want to use the play test command for normal development. Using this has two benefits 1) the @test modules are available so you can see what's breaking, and 2) it provides test data for you to work with. You also do not need any additional services like a database because it's configured to use the built-in in memory database.

Everything must be tested

We have worked really hard to make Vireo as much as possible be 100% covered by test cases. We've done the bulk of the hard work so don't leave that out whatever cool new feature you are developing on Vireo. If a pull request does con have accompanying tests then it will not be considered.
- Unit tests for all Java APIs
- Functional tests for all controllers
- Qunit tests for all Javascript
All tests must pass

As a follow on to the everything must be tested, all of those tests must also pass. We strive to have the current master branch always ready to be released.
```
// Start play with tests enabled
play test

// For unit & functional tests
http://localhost:9000/@tests

// For quint javascript tests
http://localhost:9000/@qunit
```
Everything needs to be documented at the code level

You must include code level documentation with all pull requests.

Provide feedback