Skip to content

doc: consolidate N-API material in Colalborator Guide #26094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: consolidate N-API material in Colalborator Guide #26094

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
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