Skip to content

Commit a621ab8

Browse files
addaleaxMylesBorins
authored andcommittedDec 17, 2019
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 <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 88bca0f commit a621ab8

File tree

3 files changed

+902
-1
lines changed

3 files changed

+902
-1
lines changed
 

Diff for: ‎CPP_STYLE_GUIDE.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# C++ Style Guide
22

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+
36
## Table of Contents
47

58
* [Guides and References](#guides-and-references)

Diff for: ‎doc/guides/contributing/pull-requests.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ in the API docs will also be checked when running `make lint` (or
121121
use `REPLACEME` for the version number in the documentation YAML.
122122

123123
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.
125127

126128
### Step 4: Commit
127129

0 commit comments

Comments
 (0)
Please sign in to comment.