Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update links in CONTRIBUTING.md #283

Closed
wants to merge 2 commits into from
Closed

Update links in CONTRIBUTING.md #283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6acc61c
Update links in CONTRIBUTING.md
DonovanChan Jun 26, 2019
b4ab0cb
Update Docker instructions for tests
DonovanChan Jun 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The agent includes a suite of unit and functional tests which should be used to
verify your changes don't break existing functionality.

Unit tests are stored in `test/`. They're written in
[Mocha](http://visionmedia.github.io/mocha/), and have the extension
[Mocha](https://github.com/mochajs/mocha), and have the extension
`.test.js`.

Generic functional tests are stored in `test/integration/`. They're written in
Expand All @@ -48,9 +48,9 @@ To run the tests you need an openssl command-line binary, and some services:

If you have these all running locally on the standard ports, then you are good
to go. However, the suggested path is to use [Docker](http://www.docker.com).
If you use OS X or Windows, use Docker Machine, which can be installed as a part of
[Docker Toolbox](https://www.docker.com/docker-toolbox). Then, run `npm run services`
to start docker containers for each of the above services.
If you use macOS or Windows, install [Docker Desktop]
(https://www.docker.com/products/docker-desktop). Then, run `npm run services`
to download and launch docker containers for each of the above services.

If you have these services available on non-standard ports or elsewhere on your
network, you can use the following environment variables to tell the tests where
Expand Down