From f819647329b1975db1c3ca6d9f193ad9a01f5f7b Mon Sep 17 00:00:00 2001 From: Brendan Forster Date: Thu, 11 Dec 2014 15:23:49 +1030 Subject: [PATCH] make it clearer that a test account is a good idea --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45beba7aaa..a14a8f5914 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,15 +96,16 @@ Run this command to confirm all the tests pass: `.\build` ### Running integration tests Octokit has integration tests that access the GitHub API, but they must be -configured before they will be executed. To configure the tests, create a -test GitHub account (i.e., don't use your real GitHub account) and a test -organization owned by that account. Then set the following environment variables: +configured before they will be executed. + +**Note:** To run the tests, we highly recommend you create a test GitHub +account (i.e., don't use your real GitHub account) and a test organization +owned by that account. Then set the following environment variables: `OCTOKIT_GITHUBUSERNAME` (set this to the test account's username) `OCTOKIT_GITHUBPASSWORD` (set this to the test account's password) `OCTOKIT_GITHUBORGANIZATION` (set this to the test account's organization) - Once these are set, the integration tests will be executed both when running the FullBuild MSBuild target, and when running the Octokit.Tests.Integration assembly through an xUnit.net-friendly test runner.