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 f135c38

Browse filesBrowse files
addaleaxaddaleax
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
Copy full SHA for f135c38

File tree

Expand file treeCollapse file tree

3 files changed

+902
-1
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

3 files changed

+902
-1
lines changed
Open diff view settings
Collapse file

‎CPP_STYLE_GUIDE.md‎

Copy file name to clipboardExpand all lines: CPP_STYLE_GUIDE.md
+3Lines changed: 3 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
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)
Collapse file

‎doc/guides/contributing/pull-requests.md‎

Copy file name to clipboardExpand all lines: doc/guides/contributing/pull-requests.md
+3-1Lines changed: 3 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.