Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 4.24 KB

DEVELOPING.md

File metadata and controls

94 lines (64 loc) · 4.24 KB
Raw

Development Guidelines

This document describes tools, tasks and workflow that one needs to be familiar with in order to effectively maintain this project. If you use this package within your own software as is but don't plan on modifying it, this guide is not for you.

Tools

  • Bundler: used to ensure gems that are used as dependencies are uniform with other contributors and maintainers. The first thing you should do once you've cloned this repository is to run bundle install. This will also generate the Gemfile.lock file, which caches the configuration of gems you are using. Bundler is included with all recent versions of Ruby.

  • Rake: used to run predefined tasks. Rake is usually run by prefixing bundle exec to ensure that dependencies used for the task are provided through bundler. Example: $ bundle exec rake spec. Rake is installed by Bundler when bundler install is run.

Tasks

Building

Building is required to generate the gem. A gem is a distributable artifact suitable for installing on other systems.

  • rake build - builds the gem into the pkg directory.

Testing

This project's tests are written using RSpec. It also uses the VCR and WebMock helpers.

  • rake spec - run the test suite.

Generating Documentation

This project's reference documentation is generated by Yard and resides in the docs directory of the project. Common tasks:

  • rake yard - generate the reference documentation.

Releasing

In order to create a release, the following should be completed in order.

  1. Ensure all tests are passing (rake spec) and that there is enough test coverage.
  2. Make sure you are on the dev branch of the repository, with all changes merged/committed already.
  3. Update the version number in the source code (lib/opentok/version.rb) and the README. See Versioning for information about selecting an appropriate version number.
  4. Commit the version number change with the message ("Update to version v.x.x.x"), substituting the new version number.
  5. Ensure you have permission to update the opentok gem on Rubygems: https://rubygems.org/gems/opentok.
  6. Run rake release, which will create a git tag for the version number, build, and push the gem to Rubygems.
  7. Change the version number for future development by adding ".alpha.1", then make another commit with the message "Beginning development on next version".
  8. Push the changes to the main repository (git push origin dev).
  9. Add a description to the GitHub Releases page with any notable changes. Upload the built gem as an attachment.

Workflow

Versioning

The project uses semantic versioning as a policy for incrementing version numbers. For planned work that will go into a future version, there should be a Milestone created in the Github Issues named with the version number (e.g. "v2.2.1").

During development the version number should end in ".alpha.1" or ".beta.x", where x is an increasing number starting from 1.

Branches

  • dev - the main development branch.
  • master - reflects the latest stable release.
  • feat.foo - feature branches. these are used for longer running tasks that cannot be accomplished in one commit. once merged into dev, these branches should be deleted.
  • vx.x.x - if development for a future version/milestone has begun while dev is working towards a sooner release, this is the naming scheme for that branch. once merged into dev, these branches should be deleted.

Tags

  • vx.x.x - commits are tagged with a final version number during release.

Issues

Issues are labelled to help track their progress within the pipeline.

  • no label - these issues have not been triaged.
  • bug - confirmed bug. aim to have a test case that reproduces the defect.
  • enhancement - contains details/discussion of a new feature. it may not yet be approved or placed into a release/milestone.
  • wontfix - closed issues that were never addressed.
  • duplicate - closed issue that is the same to another referenced issue.
  • question - purely for discussion

Management

When in doubt, find the maintainers and ask.