1
0
Fork 0
mirror of https://github.com/awesome-print/awesome_print synced 2023-03-27 23:22:34 -04:00
awesome_print/CONTRIBUTING.md
Mauro George eff2239e37 Updates documentation and utilize social tools
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
2014-12-31 13:44:22 -05:00

1.2 KiB

Contributing

We love pull requests. Here's a quick guide:

  1. Fork the repo.

  2. Create your feature branch (git checkout -b my-new-feature)

  3. Update CHANGELOG.md with a brief description of your changes under the unreleased heading.

  4. Commit your changes (git commit -am 'Added some feature')

  5. Push to the branch (git push origin my-new-feature)

  6. 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