Skip to content

Commit

Permalink
doc: consolidate N-API material in Collaborator Guide
Browse files Browse the repository at this point in the history
Consolidate the N-API material in the Collaborator Guide to be succinct
and direct.

PR-URL: #26094
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
  • Loading branch information
Trott authored and rvagg committed Feb 28, 2019
1 parent 82bc68b commit a9c4437
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,15 +312,10 @@ For pull requests introducing new core modules:

### Additions to N-API

N-API provides an ABI-stable API guaranteed for future Node.js versions.
Existing N-API APIs cannot change or disappear, even in semver-major releases.
Thus, N-API additions call for unusual care and scrutiny.

This
[guide](https://github.com/nodejs/node/blob/master/doc/guides/adding-new-napi-api.md)
outlines the requirements and principles that we should follow when
approving and landing new N-API APIs (any additions to `node_api.h` and
`node_api_types.h`).
N-API provides an ABI-stable API guaranteed for future Node.js versions. N-API
additions call for unusual care and scrutiny. If a change adds to `node_api.h`
or `node_api_types.h`, consult [the relevant
guide](https://github.com/nodejs/node/blob/master/doc/guides/adding-new-napi-api.md).

### Deprecations

Expand Down

0 comments on commit a9c4437

Please sign in to comment.