By all means.
How To Contribute
To contribute new code/changes:
- Fork the project
- Please use a topic branch to make your changes, it’s easier to test them that way
- Fix, patch, enhance, document, improve, sprinkle pixie dust
- Tests. Please. Run
rakeand if possible CI (see below)
- Send a pull request on GitHub
Bonus points for helping improve the documentation, writing some examples, and adding more test coverage.
Building From Source
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: