diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-02-13 23:44:14 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-02-16 15:30:45 -0800 |
| commit | 5bb7764b68e6cd9ef510df6f31c82c8f38e0f14c (patch) | |
| tree | 974e9051e24fd93c0273ae60abd802a3245b1f3b /COLLABORATOR_GUIDE.md | |
| parent | bc724707881fd1be9d083f14987e9fa28f2ebadb (diff) | |
| download | android-node-v8-5bb7764b68e6cd9ef510df6f31c82c8f38e0f14c.tar.gz android-node-v8-5bb7764b68e6cd9ef510df6f31c82c8f38e0f14c.tar.bz2 android-node-v8-5bb7764b68e6cd9ef510df6f31c82c8f38e0f14c.zip | |
doc: consolidate N-API material in Collaborator Guide
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>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index aa1406a990..726cc4bd65 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -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 |