From c132035f7c44bf6b720dc5c7faa87517922cff31 Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Wed, 20 Nov 2019 00:57:49 +0100 Subject: src,doc: add C++ internals documentation This aims to help explain some of the internal patterns and utilities that we use. It is by no means exhaustive, and suggestions for additions are welcome. Some of this is based on the existing work from #26929. Refs: https://github.com/nodejs/node/pull/26929 PR-URL: https://github.com/nodejs/node/pull/30552 Reviewed-By: Sam Roberts Reviewed-By: Richard Lau Reviewed-By: Jiawen Geng Reviewed-By: David Carlier Reviewed-By: Joyee Cheung Reviewed-By: Colin Ihrig Reviewed-By: Gireesh Punathil Reviewed-By: Denys Otrishko Reviewed-By: James M Snell Reviewed-By: Michael Dawson --- doc/guides/contributing/pull-requests.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'doc/guides/contributing') diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index f23c92fa02..31e3ba6475 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -121,7 +121,9 @@ in the API docs will also be checked when running `make lint` (or use `REPLACEME` for the version number in the documentation YAML. For contributing C++ code, you may want to look at the -[C++ Style Guide](../../../CPP_STYLE_GUIDE.md). +[C++ Style Guide](../../../CPP_STYLE_GUIDE.md), as well as the +[README of `src/`](../../../src/README.md) for an overview over Node.js +C++ internals. ### Step 4: Commit -- cgit v1.2.3