Commit f135c38
committed
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: #26929
PR-URL: #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>1 parent 36671f9 commit f135c38
3 files changed
Lines changed: 902 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,8 @@ | |||
| 1 | 1 | # C++ Style Guide | |
| 2 | 2 | ||
| 3 | + See also the [C++ codebase README](src/README.md) for C++ idioms in the Node.js | ||
| 4 | + codebase not related to stylistic issues. | ||
| 5 | + | ||
| 3 | 6 | ## Table of Contents | |
| 4 | 7 | ||
| 5 | 8 | * [Guides and References](#guides-and-references) | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -121,7 +121,9 @@ in the API docs will also be checked when running `make lint` (or | |||
| 121 | 121 | use `REPLACEME` for the version number in the documentation YAML. | |
| 122 | 122 | ||
| 123 | 123 | For contributing C++ code, you may want to look at the | |
| 124 | - [C++ Style Guide](../../../CPP_STYLE_GUIDE.md). | ||
| 124 | + [C++ Style Guide](../../../CPP_STYLE_GUIDE.md), as well as the | ||
| 125 | + [README of `src/`](../../../src/README.md) for an overview over Node.js | ||
| 126 | + C++ internals. | ||
| 125 | 127 | ||
| 126 | 128 | ### Step 4: Commit | |
| 127 | 129 | ||
0 commit comments