From 5cccc5545b0edfa41062497d2bd06a90dff027cd Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 29 Aug 2018 16:19:42 -0400 Subject: [PATCH] doc: add reference to guide for N-API additions Add reference to guide with requirements/principles for accepting additions to N-API. PR-URL: https://github.com/nodejs/node/pull/22593 Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- COLLABORATOR_GUIDE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 478908c8b1d023..c073c07a7f0996 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -21,6 +21,7 @@ - [When Breaking Changes Actually Break Things](#when-breaking-changes-actually-break-things) - [Reverting commits](#reverting-commits) - [Introducing New Modules](#introducing-new-modules) + - [Additions to N-API](#additions-to-n-api) - [Deprecations](#deprecations) - [Involving the TSC](#involving-the-tsc) * [Landing Pull Requests](#landing-pull-requests) @@ -411,6 +412,18 @@ For new modules that involve significant effort, non-trivial additions to Node.js or significant new capabilities, an [Enhancement Proposal][] is recommended but not required. +### Additions to N-API + +N-API provides an ABI stable API that we will have to support in future +versions without the usual option to modify or remove existing APIs on +SemVer boundaries. Therefore, additions need to be managed carefully. + +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`). + ### Deprecations [_Deprecation_][] is "the discouragement of use of some … feature … or practice,