From 2a23eb6a6095c71d3b86a44e41439366883b2ec3 Mon Sep 17 00:00:00 2001 From: Eric Saxby Date: Mon, 20 May 2024 14:22:07 -0700 Subject: [PATCH] Add GITHUB_TOKEN information to contributing guide (#272) --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95749a8..2b2f234 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,13 @@ Here are a few things you can do that will increase the likelihood of your pull - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). - Execute `npm run build-dist` and fix any issues arising from that +## Running tests + +When running tests locally, a valid classic GitHub token with the `repo` scope is required for tests to pass. + +- Export the token in the current shell: `export GITHUB_TOKEN=` +- Run tests `npm test` + ## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)