Create CONTRIBUTING file Add rubygems badge Add code climate badge Add badge of total of downloads Add badges flat style Add changelog of the changes Add info about how to use appraisal Fix link to changelog on CONTRIBUTING Add Semantic Version on the README
1.2 KiB
Contributing
We love pull requests. Here's a quick guide:
-
Fork the repo.
-
Create your feature branch (
git checkout -b my-new-feature
) -
Update CHANGELOG.md with a brief description of your changes under the
unreleased
heading. -
Commit your changes (
git commit -am 'Added some feature'
) -
Push to the branch (
git push origin my-new-feature
) -
Create new Pull Request
At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted is to follow the practices described on Ruby style guide, Rails style guide and Better Specs.
Specs
To run all the specs in all gemfiles just run:
$ rake
To run specs of a single gemfile run:
$ appraisal rails-3.2 rake
If you want to run a specific spec in a gemfile run:
$ appraisal rails-3.2 rspec spec/colors_spec.rb