Add GITHUB_TOKEN information to contributing guide (#272)

2026-07-22 22:56:07 +00:00 · 2024-05-20 14:22:07 -07:00
parent f780b59067
commit 2a23eb6a60
1 changed files with 7 additions and 0 deletions
@@ -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=<contents>`
+- Run tests `npm test`
+
 ## Resources

 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)