CONTRIBUTING.md

Contributing to Testee

Developing Locally

This section will walk you through setting up the repository on your computer.

Signing up for GitHub

If you don’t already have a GitHub account, you’ll need to create a new one.

Forking & cloning the repository

A “fork” is a copy of a repository in your personal GitHub account. “Cloning” is the process of getting the repository’s source code on your computer.

GitHub has a guide for forking a repo. To fork testee, you can start by going to its fork page.

Next, you’ll want to clone the repo. GitHub’s cloning guide explains how to do this on Linux, Mac, or Windows.

GitHub’s guide will instruct you to clone it with a command like:

git clone https://github.com/YOUR-USERNAME/testee

Make sure you replace YOUR-USERNAME with your GitHub username.

Installing the dependencies

After you’ve forked & cloned the repository, you’ll need to install the project’s dependencies.

First, make sure you’ve installed Node.js and npm.

If you just cloned the repo from the command line, you’ll want to switch to the folder with your clone:

cd test

Next, install the project’s dependencies with npm:

npm install --no-shrinkwrap

Running the tests

Firefox is used to run the repository’s automated tests from the command line. If you don’t already have it, download Firefox. Mozilla has guides for installing it on Linux, Mac, and Windows.

After Firefox is installed, you can run:

npm test

Making a release

Run any of following commands to make a release:

npm version prerelease
npm version patch
npm version minor
npm version major

This will run the tests, make a build, bump the version number, and push the git tag for the release.