Contributing
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:
- Fork the project
- Make your changes in a topic branch
- Include tests for the new behavior
- Make a pull request
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 test
To test Vanity with all supported adapters, or a specific adapter:
$ rake test:adapters $ rake test:adapters[redis]
To test Vanity with all supported Ruby implementations, or a specific implementation:
$ rake test:rubies $ rake test:rubies[1.9.2] $ # or $ rvm 1.9.2@vanity rake test
If you have RVM installed, rake test:rubies will install all the supported Ruby implementations and populate the vanity gemset for you. To test all supported adapters, you will also need to install Redis and MongoDB. If working on the Mac, you can easily install them using Homebrew.
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