Skip to content

Commit

Permalink
src,doc: add C++ internals documentation
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
addaleax authored and MylesBorins committed Dec 17, 2019
1 parent 88bca0f commit a621ab8
Show file tree
Hide file tree
Showing 3 changed files with 902 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CPP_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# C++ Style Guide

See also the [C++ codebase README](src/README.md) for C++ idioms in the Node.js
codebase not related to stylistic issues.

## Table of Contents

* [Guides and References](#guides-and-references)
Expand Down
4 changes: 3 additions & 1 deletion doc/guides/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading

0 comments on commit a621ab8

Please sign in to comment.