Skip to content

Commit c1e9ba1

Browse files
committed
Update CONTRIBUTING.md; related #813.
1 parent b9b7464 commit c1e9ba1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,20 @@ To contribute to Observable Plot, you’ll need a local development environment
1212
yarn
1313
```
1414

15+
You may encounter an error installing [node-canvas](https://github.com/Automattic/node-canvas), such as:
16+
17+
```
18+
node-pre-gyp ERR! install response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.9.1/canvas-v2.9.1-node-v93-darwin-unknown-arm64.tar.gz
19+
node-pre-gyp WARN Pre-built binaries not installable for [email protected] and [email protected] (node-v93 ABI, unknown) (falling back to source compile with node-gyp)
20+
node-pre-gyp WARN Hit error response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.9.1/canvas-v2.9.1-node-v93-darwin-unknown-arm64.tar.gz
21+
```
22+
23+
If this happens, you will need to [compile node-canvas from source](https://github.com/Automattic/node-canvas/blob/master/Readme.md#compiling)in order to develop Plot. For example, on macOS, you can use Homebrew to install the needed dependencies:
24+
25+
```bash
26+
brew install pkg-config cairo pango libpng jpeg giflib librsvg
27+
```
28+
1529
## Testing
1630

1731
After making changes to Plot’s source code, run Plot’s test suite to verify that your code is doing what you expect and that you haven’t introduced any other unexpected changes in behavior. Plot has two types of tests: **unit tests** and **snapshot tests**. Tests are run automatically on pull requests (via GitHub Actions), but you’ll want to run them locally to verify your changes before opening a pull request. To run the tests, use Yarn:

0 commit comments

Comments
 (0)