diff options
| author | Anna Henningsen <anna@addaleax.net> | 2019-11-20 00:57:49 +0100 |
|---|---|---|
| committer | Anna Henningsen <anna@addaleax.net> | 2019-11-22 21:28:32 +0100 |
| commit | c132035f7c44bf6b720dc5c7faa87517922cff31 (patch) | |
| tree | b8d6f85356c252d83b0fef0ff6e6dd4add019370 /doc/guides/contributing | |
| parent | 19e44efdfba4450ea6cc32780adda42fd31a10a7 (diff) | |
| download | android-node-v8-c132035f7c44bf6b720dc5c7faa87517922cff31.tar.gz android-node-v8-c132035f7c44bf6b720dc5c7faa87517922cff31.tar.bz2 android-node-v8-c132035f7c44bf6b720dc5c7faa87517922cff31.zip | |
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 <vieuxtech@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/guides/contributing')
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 4 |
1 files changed, 3 insertions, 1 deletions
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 |