Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (20 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.11 KB

Contributing

Running the test suite

bundle exec rake spec

Code quality

Code quality is checked with cane configured in Rakefile.

Build fails if code quality thresholds are not met.

Code coverage

When running the test suite a test coverage report is generated with SimpleCov in coverage/index.html.

Build fails if coverage is below 99%.

Writing new tests

Azimuth uses VCR for recording and playing back API fixtures (in spec/cassettes) during test runs.

If you need to record new cassettes you have to provide your MapQuest API key in ENV['MAP_QUEST_API_KEY'] (stripped automaticaly from the cassette before being saved on disk).

Documentation

Documentation is generated with YARD.

Workflow

  1. Fork Azimuth
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request