Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 3.72 KB

DEVELOPING.md

File metadata and controls

89 lines (63 loc) · 3.72 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

  • Grunt: used to run predefined tasks. Install all development dependencies (npm install) and also install the grunt CLI (npm install -g grunt-cli).

Tasks

Testing

This project's tests are written with Mocha and with Jasmine. Common tasks:

  • grunt - run the complete test suite.
  • grunt mochaTest - run just the mocha tests
  • grunt jasmine_node - run just the jasmine tests

Generating Documentation

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

  • grunt jsdoc - generate the reference documentation.

Releasing

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

  1. Ensure all the tests are passing (grunt) and that there is enough test coverage.
  2. Make sure you are on the master branch of the repository, with all changes merged/commited already.
  3. Update the version number anywhere it appears in the source code and documentation. See Versioning for information about selecting an appropriate version number. Files to check:
    • package.json
  4. Commit the version number change with the message "Update to version x.y.z", substituting the new version number.
  5. Create a git tag: git tag -a vx.y.z -m "Release vx.y.z"
  6. Ensure that you have permission to update the opentok npm module
  7. Run npm publish to release to npm.
  8. Change the version number for future development by incrementing the patch number (z) adding "-alpha.1" in the source code (not the documentation). For possible files, see above. Then make another commit with the message "Begin development on next version".
  9. Push the changes to the source repository: git push origin master && git push --tags origin
  10. Add a description to the GitHub Releases page with any notable changes.

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.x" or "-beta.x", where x is an increasing number starting from 1.

Branches

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