Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

80 lines (57 loc) · 1.94 KB

How to contribute

Pull requests

We love your contributions, thanks for taking the time to contribute!

It's really easy to start contributing, just follow these simple steps:

  1. Fork the repo:

  2. Run the test suite to make sure the tests pass:

bundle exec rake
  1. Create a separate branch, commit your work and push it to your fork. If you add comments, please make sure that they are compatible with YARD:
git checkout -b my-branch
git commit -am
git push origin my-branch
  1. Verify that your code doesn't offend Rubocop:
bundle exec rubocop
  1. Verify that your code's documentation is correct:
bundle exec yardoc --fail-on-warning --no-progress --readme=README
  1. Run the test suite again (new tests are always welcome):
bundle exec rake
  1. Make a pull request

Submitting issues

Our issue tracker is a perfect place for filing bug reports or discussing possible features. If you report a bug, consider using the following template (copy-paste friendly):

* Airbrake version: {YOUR VERSION}
* Ruby version: {YOUR VERSION}
* Framework name & version: {YOUR DATA}

#### Airbrake config

    # YOUR CONFIG
    #
    # Make sure to delete any sensitive information
    # such as your project id and project key.

#### Description

{We would be thankful if you provided steps to reproduce the issue, expected &
actual results, any code snippets or even test repositories, so we could clone
it and test}