Permalink
Browse files

Move "Contributing" section into dedicated document for better GitHub…

  • Loading branch information...
1 parent fa76f32 commit 06f666830ade1bc9611fdd46388a80f62406c46a @sferik sferik committed Oct 7, 2012
Showing with 24 additions and 5 deletions.
  1. +14 −0 CONTRIBUTING.md
  2. +10 −5 README.md
View
@@ -0,0 +1,14 @@
+## How to contribute
+
+If you find what looks like a bug:
+
+* Search the [mailing list](http://groups.google.com/group/delayed_job) to see if anyone else had the same issue.
+* Check the [GitHub issue tracker](http://github.com/collectiveidea/delayed_job_mongoid/issues/) to see if anyone else has reported issue.
+* If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+* Fork the project on github.
+* Make your changes with tests.
+* Commit the changes without making changes to the Rakefile or any other files that aren't related to your enhancement or fix
+* Send a pull request.
View
@@ -1,22 +1,27 @@
-# delayed_job Mongoid backend [![Build Status](https://secure.travis-ci.org/collectiveidea/delayed_job_mongoid.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/collectiveidea/delayed_job_mongoid.png?travis)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
+# delayed_job Mongoid backend
+[![Build Status](https://secure.travis-ci.org/collectiveidea/delayed_job_mongoid.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/collectiveidea/delayed_job_mongoid.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
[travis]: http://travis-ci.org/collectiveidea/delayed_job_mongoid
[gemnasium]: https://gemnasium.com/collectiveidea/delayed_job_mongoid
[codeclimate]: https://codeclimate.com/github/collectiveidea/delayed_job_mongoid
## Requirements
-Make sure you are using MongoDB version 1.3 or newer. `delayed_job_mongoid` uses the `findandmodify` command which is only available in recent versions.
-
+Make sure you are using MongoDB version 1.3 or newer. `delayed_job_mongoid`
+uses the `findandmodify` command which is only available in recent versions.
## Installation
Add the gem to your Gemfile:
gem 'delayed_job_mongoid'
-After running `bundle install`, create the indexes (and don't forget to do this on your production database):
+After running `bundle install`, create the indexes (and don't forget to do this
+on your production database):
script/rails runner 'Delayed::Backend::Mongoid::Job.create_indexes'
-That's it. Use [delayed_job as normal](http://github.com/collectiveidea/delayed_job).
+That's it. Use [delayed_job](http://github.com/collectiveidea/delayed_job) as
+normal.

0 comments on commit 06f6668

Please sign in to comment.