neiam /action-setup-beam
action-setup-beam
public · Issues · Pulls · Labels · Forks · Compare · Actions queued
⭐
Log in to mark this repository.
Add GITHUB_TOKEN information to contributing guide (#272)
2a23eb6 · Eric Saxby · 2024-05-20 21:22
Files changed
modified
CONTRIBUTING.md
+7
−0
@@ -27,6 +27,13 @@ Here are a few things you can do that will increase the likelihood of your pull
| 27 | 27 | - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). |
| 28 | 28 | - Execute `npm run build-dist` and fix any issues arising from that |
| 29 | 29 | |
| 30 | +## Running tests | |
| 31 | + | |
| 32 | +When running tests locally, a valid classic GitHub token with the `repo` scope is required for tests to pass. | |
| 33 | + | |
| 34 | +- Export the token in the current shell: `export GITHUB_TOKEN=<contents>` | |
| 35 | +- Run tests `npm test` | |
| 36 | + | |
| 30 | 37 | ## Resources |
| 31 | 38 | |
| 32 | 39 | - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) |
Parents: f780b59