CONTRIBUTING.md
Contributing to Resque
======================
First of all: thank you! We appreciate any help you can give Resque.
The main way to contribute to Resque is to write some code! Here's how:
1. [Fork](https://help.github.com/articles/fork-a-repo) Resque
2. Create a topic branch - `git checkout -b my_branch`
3. Push to your branch - `git push origin my_branch`
4. Create a [Pull Request](http://help.github.com/pull-requests/) from your
branch
5. That's it!
An entry in the `HISTORY.md` is appropriate for changes that aren't of purely
internal consequences. Please include a modification of HISTORY.md adding a
bullet for your change in your pull request where relevant.
Oh, and 80 character columns, please!
Tests
-----
We use minitest for testing.
A simple `bundle exec rake` will run all the tests. Make sure they pass when
you submit a pull request.
Please include tests with your pull request.
Documentation
-------------
Writing docs is really important. We use yard to generate our documentation.
Please include docs in your pull requests.
Bugs & Feature Requests
-----------------------
You can file bugs on the [issues
tracker](https://github.com/resque/resque/issues), and tag them with 'bug'.
When filing a bug, please follow these tips to help us help you:
### Good report structure
Please include the following four things in your report:
1. What you did.
2. What you expected to happen.
3. What happened instead.
4. What version of Resque you're using. You can find this with
`$ gem list resque`.
The more information the better.
### Reproduction
If possible, please provide some sort of executable reproduction of the issue.
Your application has a lot of things in it, and it might be a complex
interaction between components that causes the issue.
To reproduce the issue, please make a simple Job that demonstrates the essence
of the issue. If the basic job doesn't demonstrate the issue, try adding the
other gems that your application uses to the Gemfile, even if they don't seem
directly relevant.
### Version information
If you can't provide a reproduction, a copy of your Gemfile.lock would be
helpful.
Help
----
If you have a question or want to discuss something, the Resque mailng list
might just be the place. [resque@librelist.com](mailto:resque@librelist.com)
is the address you want, send an email there and it'll take care of you.