Update README with build status, license, and version info. Add developing and contributing guidelines.

adrice727 · adrice727 · commit 5e6b1ebd2d79 · 2017-12-13T17:40:15.000-08:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+# Contributing Guidelines
+
+For anyone looking to get involved to this project, we are glad to hear from you. Here are a few types of contributions
+that we would be interested in hearing about.
+
+*  Bug fixes
+    -  If you find a bug, please first report it using Github Issues.
+    -  Issues that have already been identified as a bug will be labelled `bug`.
+    -  If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
+        +  Include a test that isolates the bug and verifies that it was fixed.
+*  New Features
+    -  If you'd like to accomplish something in the library that it doesn't already do, describe the problem in a new
+       Github Issue.
+    -  Issues that have been identified as a feature request will be labelled `enhancement`.
+    -  If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
+       too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at
+       the time.
+*  Tests, Documentation, Miscellaneous
+    -  If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
+       implementation of something that may have more advantages, or any other change we would still be glad hear about
+       it.
+       -  If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
+       -  If not, open a Github Issue to discuss the idea first.
+
+## Requirements
+
+For a contribution to be accepted:
+
+*  The test suite must be complete and pass
+*  Code must follow existing styling conventions
+*  Commit messages must be descriptive. Related issues should be mentioned by number.
+
+If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still
+continue to add more commits to the branch you have sent the Pull Request from.
+
+## How To
+
+1. Fork this repository on GitHub.
+1. Clone/fetch your fork to your local development machine.
+1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) from the 'develop' and check it out.
+1. Make your changes and commit them. (Did the tests pass?)
+1. Push your new branch to your fork. (e.g. `git push myname issue-12`)
+1. Open a Pull Request from your new branch to the original fork's `develop` branch.
+
+## Developer Guidelines
+
+See DEVELOPING.md for guidelines for developing this project.
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -0,0 +1,94 @@
+# 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
+
+This project is developed with [TypeScript](https://www.typescriptlang.org/) and uses [Webpack](https://webpack.js.org/) in conjunction with [Babel](https://babeljs.io/) to compile and bundle code into a browser-friendly UMD module.  To install the dependencies required for development, simply run:
+```
+$ npm install
+```
+
+## Tasks
+
+### Build
+
+To compile and bundle the package:
+```
+$ npm run build
+```
+
+### Test
+This project's tests are written with Karma and Jasmine. Before running the tests, you will need to create a `.env` file with the following values in the root directory of the repository.
+```
+TEST_API_KEY={OPENTOK_API_KEY}
+TEST_API_SECRET={OPENTOK_API_SECRET}
+```
+*You can obtain a project key and secret from the TokBox [Account Portal](https://tokbox.com/account/).*
+
+To run the tests:
+```
+$ npm run test
+```
+
+### Releasing
+
+In order to create a release, the following should be completed in order.
+
+1. Build the project and ensure that there are no `typescript` or `tslint` errors.
+1. Ensure all the tests are passing.
+1. Make sure you are on the `develop` branch of the repository, with all changes merged/commited
+   already.
+1. Update the version number anywhere it appears in the source code and documentation. See [Versioning](#versioning) for information about selecting an appropriate version number. Files to check:
+   - package.json
+1. Commit the version number change with the message "Update to version x.y.z", substituting the new
+   version number.
+1. Create a git tag: `git tag -a vx.y.z -m "Release vx.y.z"`
+1. Ensure that you have permission to update the
+   [opentok npm module](https://www.npmjs.org/package/opentok)
+1. Run `npm publish` to release to npm.
+1. 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".
+1. Push the changes to the source repository: `git push origin dev && git push --tags origin`
+1. Add a description to the [GitHub Releases](https://github.com/opentok/opentok-node/releases) page with any notable changes.
+
+## Workflow
+
+### Versioning
+
+The project uses [semantic versioning](http://semver.org/) 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
+
+*  `develop` - 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 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.
+
diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
+
+![logo](https://raw.githubusercontent.com/opentok/opentok-network-test-js/master/media/tokbox-logo.png)
+
 # OpenTok Network Test
 
-![logo](./media/tokbox-logo.png)
+[![Build Status](https://travis-ci.org/opentok/opentok-network-test-js.svg?branch=master)](https://travis-ci.org/opentok/opentok-network-test-js)
+[![license](https://img.shields.io/github/license/opentok/opentok-network-test-js.svg)](./.github/CONTRIBUTING.md)
+[![npm](https://img.shields.io/npm/v/opentok-network-test-js.svg)](https://www.npmjs.com/package/opentok-accelerator-core)
 
 This Node module lets you check network connectivity to resources and services required
 to use [OpenTok](https://tokbox.com). Run this on a web client to get the following information:
@@ -19,15 +24,14 @@ tool](https://tokbox.com/developer/tools/precall/).
 
 First, install the package:
 
-npm install opentok-network-test-js
-
-*Important:* The node module is not currently available on npmjs.com. For now, see
-the instructions on building the module below.
+```
+$ npm install opentok-network-test-js
+```
 
 Now load the OpenTok Network Test in your project:
 
 ```javascript
-var OTNetworkTest = require('opentok-network-test-js');
+const OTNetworkTest = require('opentok-network-test-js');
 ```
 
 Load the OpenTok.js library.
@@ -49,7 +53,7 @@ unique session ID for each client. This session ID is used for the network test,
 be different than the session ID used for communication in the app. The test session must be
 a routed session -- one that uses the [OpenTok Media
 Router](https://tokbox.com/developer/guides/create-session/#media-mode). Also generate a test
-token that has publish privileges. 
+token that has publish privileges.
 
 Then run the test methods:
 
@@ -92,7 +96,7 @@ otNetworkTest.testConnectivity().then((results) => {
 
 This code uses Promises returned by the `OTNetworkTest.testConnectivity()`
 and `OTNetworkTest.testQuality()` methods. Alternatively, you can pass completion
-handler functions into each of these methods. 
+handler functions into each of these methods.
 
 See the following section for details on using the test results.
 
@@ -154,7 +158,7 @@ This callback function takes two parameters:
 
 * `error` -- An Error object. The `name` Property of this object is set to `ConnectivityError`.
   The `message` property describes the reason for the error. This will usually result from an
-  invalid API key, session ID, or token passed into the `OTNetworkTest()` constructor. This 
+  invalid API key, session ID, or token passed into the `OTNetworkTest()` constructor. This
   is only set when the test could not run because of an error. If the connectivity can run
   (even if it results in failed tests), this property is undefined.
 
@@ -269,15 +273,15 @@ is invoked when the connectivity check completes. This callback function takes t
         For example, `'No microphone was found.'`
 
       * `bitrate` (Number) -- The average number of video bits per second during the last
-        five seconds of the test. 
+        five seconds of the test.
 
       * `frameRate` (Number) -- The average number of frames per second during the last five seconds
         of the test. Note that this is different than the `recommendedFrameRate`. The `frameRate`
         value is the actual frame rate observed during the test, and the `recommendedFrameRate`
         is the recommended frame rate.
 
       * `packetLossRatio` (Number) -- The audio packet loss ratio during the last five seconds
-        of the test. 
+        of the test.
 
   * `audio` (Object) -- Contains the following properties:
 
@@ -287,10 +291,10 @@ is invoked when the connectivity check completes. This callback function takes t
       For example, `'No microphone was found.'`
 
     * `bitrate` (Number) -- The average number of audio bits per second during the last five seconds
-      of the test. 
+      of the test.
 
     * `packetLossRatio` (Number) -- The video packet loss ratio during the last five seconds
-      of the test. 
+      of the test.
 
   `results` is undefined if there was an error in running the tests (and the `error` parameter
   is unset).
