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
Gerard Caulfield 509c9ad000
Update Contributing to reflect reality
Previously it seems that PRs were responded to within 1-3 days,
however this has not been the case for about a year so I'm
udating the relevant section of this guide in order to set more
realistic expectations. This is mainly so people do not get
discouraged when they see we haven't responded after a few days.
2016-05-12 16:22:34 +10:00

2.9 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. Add/Update tests were appropriate

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

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

  7. Create new Pull Request

At this point you're waiting on us. We are not super fast at responding, but we will do our best to get to your PR as soon as time permits. We may suggest some changes, 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

Contributor Rolecall

Special thanks goes to awesome team of contributors, namely: