Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 2.15 KB
Raw

Contributing to ReadyResponder

First of all: thank you! We appreciate any help you can give ReadyResponder.

You can contribute in several ways:

  • Write some code!
  • Report an issue.
  • Provide some documentation.
  • Make a feature request.
  • Share a success story.

Many people contribute to ReadyResponder by writing some code! Here's how:

  1. Fork ReadyResponder.
  2. Clone the forked repository to your development or local machine.
  3. Create a topic branch. - git checkout -b my_branch
  4. Make your changes.
  5. Commit your changes to your branch.
  6. Push your branch to your GitHub repo. - git push origin my_branch
  7. Create a Pull Request from your branch.
  8. That's it!

If you're not doing some sort of refactoring, a CHANGELOG entry is appropriate. Please include them in pull requests adding features or fixing bugs.

Oh, and 80 character columns, please!

Tests

We use rspec for tests. A simple bundle exec rspec 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. If you are not comfortable with git, you can put documentation into an issue, and we'll get it into the application.

Please include docs in your pull requests.

Bugs & Feature Requests

You can file bugs on the issues tracker, 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 ReadyResponder you're using. You can find this in the footer on every page

The more information, the better.

Reproduction

If possible, please provide some sort of executable reproduction of the issue.

Version information

If you can't provide a reproduction, a copy of your Gemfile.lock would be helpful.