1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: consolidate N-API material in Collaborator Guide

Browse Source 
Consolidate the N-API material in the Collaborator Guide to be succinct
and direct.

PR-URL: https://github.com/nodejs/node/pull/26094
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
This commit is contained in:
Rich Trott 2019-02-13 23:44:14 -08:00
parent bc72470788
commit 5bb7764b68
1 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
COLLABORATOR_GUIDE.md
View File

@ -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