Skip to content

Commit df86f14

Browse files
committed
docs: add note concerning native add-ons
1 parent 085b73b commit df86f14

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,16 @@ The project can **never** have enough tests. To address areas lacking sufficient
372372

373373
7. Submit the test as a [pull request][github-pull-request].
374374

375+
Note that, for contributions targeting C implementations, you'll need to first compile the native add-on which provides the bridge between JavaScript and C (assuming that the package has a native add-on binding).
376+
377+
```bash
378+
$ make install-node-addons NODE_ADDONS_PATTERN="math/base/special/sin"
379+
```
380+
381+
where the pattern `math/base/special/sin` (note the differences from the filter pattern above!) matches any add-on whose absolute path contains `math/base/special/sin`.
382+
383+
Once the add-on is compiled, you can follow steps 5-7 above.
384+
375385
### Writing Documentation
376386
377387
> By contributing documentation to the project, you are agreeing to release it under the project [license][stdlib-license].

0 commit comments

Comments
 (0)