4 Development Setup & Guidelines

For those wishing to contribute to this project great I appreciate it! Here is some more information on how to get setup with a build environment.

Checkout Source Code

With git obviously. So do a:

git clone git@github.com:jdwije/LEWT.git

Once that is completed. Install using bundle, then you should be good to edit, and build the source code.

# install dependencies
bundle install

# run tests
rake tests

# build documentation
rake docs

# do both the above
rake

# package for distribution
rake package

Once you have packaged your build. You can install it locally with:

# install LEWT package
gem install pkg/lewt-0.x.x.gem

Coding conventions

Unit testing Please write unit tests for your new methods and make sure all tests are passing before sending me pull requests.

Documentation Source code is parsed with rDoc, so please observe it's markup conventions when commenting your code. It will be compiled into the documentation when you build.