Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.05 KB
Raw

Contributing

First, thank you for contributing!

Here are a few technical guidelines to follow:

  1. Open an issue to discuss a new feature
  2. Write tests
  3. Make sure the entire test suite passes locally and on CI
  4. Open a Pull Request
  5. Squash your commits after receiving feedback
  6. Party!

Development

After checking out the repo, run bin/setup to install dependencies. Run bin/hack for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run bundle exec rake install.

Testing

  1. Set up your development environment as per above.
  2. Run rake to execute the full test suite.

Release

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.