We welcome contributions of all types! This section will guide you through setting up your development environment.

1. [Install Node](https://nodejs.org/en/) version 8,10 or 11. It can often help to use a Node version switcher such as [NVM](https://github.com/nvm-sh/nvm).

2. Fork this repo to your GitHub account.

3. Clone the fork to your development machine (`git clone https://github.com/{YOUR_USERNAME}/github`).

4. From the root of the cloned repo, run `npm install`.

5. Email jaredrewerts@gmail.com with the subject **GitHub API - Personal Access Token Request**

A personal access token for our test user, @github-tools-test, will be generated for you.

6. Set the environment variable `GHTOOLS_USER` to `github-tools-test`.

7. Set the environment variable `GHTOOLS_PASSWORD` to the personal access token that was generated for you.

**NOTE** Windows users can use [this guide](http://www.dowdandassociates.com/blog/content/howto-set-an-environment-variable-in-windows-command-line-and-registry/) to learn about setting environment variables on Windows.

The main way we write code for `github-api` is using test-driven development. We use Mocha to run our tests. Given that the bulk of this library is just interacting with GitHub's API, nearly all of our tests are integration tests.

To run the test suite, run `npm run test`.