Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0c39fa4

Browse filesBrowse files
mhdawsontargos
authored andcommitted
doc: add reference to guide for N-API additions
Add reference to guide with requirements/principles for accepting additions to N-API. PR-URL: #22593 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent ef2a0bd commit 0c39fa4
Copy full SHA for 0c39fa4

File tree

Expand file treeCollapse file tree

1 file changed

+13
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+13
-0
lines changed
Open diff view settings
Collapse file

‎COLLABORATOR_GUIDE.md‎

Copy file name to clipboardExpand all lines: COLLABORATOR_GUIDE.md
+13Lines changed: 13 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [When Breaking Changes Actually Break Things](#when-breaking-changes-actually-break-things)
2222
- [Reverting commits](#reverting-commits)
2323
- [Introducing New Modules](#introducing-new-modules)
24+
- [Additions to N-API](#additions-to-n-api)
2425
- [Deprecations](#deprecations)
2526
- [Involving the TSC](#involving-the-tsc)
2627
* [Landing Pull Requests](#landing-pull-requests)
@@ -411,6 +412,18 @@ For new modules that involve significant effort, non-trivial additions to
411412
Node.js or significant new capabilities, an [Enhancement Proposal][] is
412413
recommended but not required.
413414

415+
### Additions to N-API
416+
417+
N-API provides an ABI stable API that we will have to support in future
418+
versions without the usual option to modify or remove existing APIs on
419+
SemVer boundaries. Therefore, additions need to be managed carefully.
420+
421+
This
422+
[guide](https://github.com/nodejs/node/blob/master/doc/guides/adding-new-napi-api.md)
423+
outlines the requirements and principles that we should follow when
424+
approving and landing new N-API APIs (any additions to `node_api.h` and
425+
`node_api_types.h`).
426+
414427
### Deprecations
415428

416429
[_Deprecation_][] is "the discouragement of use of some … feature … or practice,

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.