Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (50 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 1.98 KB

How to contribute

We are glad you're here! First-time and returning contributors are welcome to add bug fixes and new integrations. If you are unsure about the direction of an enhancement or if it would be generally useful, feel free to open an issue or a work-in-progress pull request and ask for input.

Thank you!

Getting started

Polish

  • Install the test dependencies

    bundle config set --local with 'test sidekiq'
bundle install
bundle binstubs --all

  • Run the tests with and make sure they all pass

    bin/rake

  • Further information on installing and running the tests can be found in the testing guide

Document

  • Write API docs for your contributions using YARD
  • Generate the API documentation locally 
    bin/rake yard
  • Review your changes by opening doc/index.html

Ship it!

How to release

If you're a member of the core team, follow these instructions for releasing bugsnag-ruby.

First time setup

  • Create a Rubygems account
  • Get someone to add you as contributor on bugsnag-ruby-performance in Rubygems

Every time

  • Create a new release branch named in the format release/v1.x.x

  • Update the version number in VERSION

  • Update CHANGELOG.md with any changes

  • Open a pull request into master and get it approved

  • Merge the pull request using the message "Release v1.x.x"

  • Make a GitHub release

  • Release to rubygems:

    gem build bugsnag.gemspec
gem push bugsnag-[version].gem

  • Update the version running in the bugsnag-website project

Update docs.bugsnag.com

Update the setup guides for Ruby (and its frameworks) with any new content.