Skip to content

Commit d6ad07a

Browse files
authored
Added developer setup instructions.
1 parent bf3a408 commit d6ad07a

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,33 @@ npm install github-api
9494
[npm-package]: https://www.npmjs.com/package/github-api/
9595
[unpkg]: https://unpkg.com/github-api/
9696
[travis-ci]: https://travis-ci.org/github-tools/github
97+
98+
## Contributing
99+
100+
We welcome contributions of all types! This section will guide you through setting up your development environment.
101+
102+
### Setup
103+
104+
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).
105+
2. Fork this repo to your GitHub account.
106+
3. Clone the fork to your development machine (`git clone https://github.com/{YOUR_USERNAME}/github`).
107+
4. From the root of the cloned repo, run `npm install`.
108+
5. Email jaredrewerts@gmail.com with the subject **GitHub API - Personal Access Token Request**
109+
110+
A personal access token for our test user, @github-tools-tests, will be generated for you.
111+
112+
6. Set the environment variable `GHTOOLS_USER` to `github-tools-tests`.
113+
114+
`export GHTOOLS_USER=github-tools-tests`
115+
116+
7. Set the environment variable `GHTOOLS_PASSWORD` to the personal access token that was generated for you.
117+
118+
`export GHTOOLS_PASSWORD={YOUR_PAT}`
119+
120+
**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.
121+
122+
### Tests
123+
124+
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.
125+
126+
To run the test suite, run `npm run test`.

0 commit comments

Comments
 (0)