Contributing

  1. How To Contribute
  2. Building From Source
  3. Documentation
  4. Open Issues

By all means.

How To Contribute

Pick on an open issue, experimental feature, suggestion from the Google Group, or whatever you feel like contributing.

To contribute new code/changes:

  1. Fork the project
  2. Please use a topic branch to make your changes, it’s easier to test them that way
  3. Fix, patch, enhance, document, improve, sprinkle pixie dust
  4. Tests. Please. Run rake and if possible CI (see below)
  5. Send a pull request on GitHub

Bonus points for helping improve the documentation, writing some examples, and adding more test coverage.

Building From Source

Vanity is tested against multiple Ruby implementations, and a variety of database engines. To make life easier, we use RVM and Bundler to set up the test/development environment.

To test Vanity for the first time under whichever Ruby implementation you’re currently using:

$ rake test:setup
$ rake

To test Vanity with specific database adapter:

$ rake DB=redis
$ rake DB=mongodb
$ rake DB=mysql

Before making a release, we run the full test suite against multiple Ruby VMs
and using multiple database adapters. Doing this on your own is easier than it
sounds:

  1. Fork the project
  2. Go to Travis CI, setup a new account if you don’t already have one
  3. In your profile page, tell Travis to build your fork
  4. git push your changes into your fork and watch Travis run the tests

To package Vanity as a gem and install on your machine:

$ rake install

Documentation

Documentation is written in Textile, and converted to HTML using Jekyll.

API reference is RDoc, converted to HTML using Yardoc.

To build and view documentation:

$ rake docs
$ open html/index.html

To clean up after yourself:

$ rake clobber

Open Issues