diff options
author | Michael Dawson <mdawson@devrus.com> | 2022-01-05 21:26:30 +0300 |
---|---|---|
committer | Michael Dawson <mdawson@devrus.com> | 2022-01-18 22:24:30 +0300 |
commit | a199387f045aa55b58c6d2e52bb69bf32c9d3d5e (patch) | |
tree | e7570b05d54b2a73edc9b7c2481a5730385654d2 /src | |
parent | 65910c0d6cdbca6d8efa919378d72eff34016f35 (diff) |
doc: make contributing info more discoverable
There are been several discussions in recent PRs about
the docs related to contributing not being very discoverable.
Move these docs from doc/guides/ to doc/contributing.
Signed-off-by: Michael Dawson <mdawson@devrus.com>
PR-URL: https://github.com/nodejs/node/pull/41408
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/README.md | 2 | ||||
-rw-r--r-- | src/base_object.h | 2 | ||||
-rw-r--r-- | src/env.h | 2 | ||||
-rw-r--r-- | src/handle_wrap.h | 2 | ||||
-rw-r--r-- | src/req_wrap.h | 2 |
5 files changed, 5 insertions, 5 deletions
diff --git a/src/README.md b/src/README.md index 25c63e2f8cc..623c3774971 100644 --- a/src/README.md +++ b/src/README.md @@ -1024,7 +1024,7 @@ static void GetUserInfo(const FunctionCallbackInfo<Value>& args) { } ``` -[C++ coding style]: ../doc/guides/cpp-style-guide.md +[C++ coding style]: ../doc/contributing/cpp-style-guide.md [Callback scopes]: #callback-scopes [JavaScript value handles]: #js-handles [N-API]: https://nodejs.org/api/n-api.html diff --git a/src/base_object.h b/src/base_object.h index d46a0f21600..1c63da92fd8 100644 --- a/src/base_object.h +++ b/src/base_object.h @@ -171,7 +171,7 @@ class BaseObject : public MemoryRetainer { // class because it is used by src/node_postmortem_metadata.cc to calculate // offsets and generate debug symbols for BaseObject, which assumes that the // position of members in memory are predictable. For more information please - // refer to `doc/guides/node-postmortem-support.md` + // refer to `doc/contributing/node-postmortem-support.md` friend int GenDebugSymbols(); friend class CleanupHookCallback; template <typename T, bool kIsWeak> diff --git a/src/env.h b/src/env.h index dfb5155b9b8..86891290416 100644 --- a/src/env.h +++ b/src/env.h @@ -1561,7 +1561,7 @@ class Environment : public MemoryRetainer { // src/node_postmortem_metadata.cc to calculate offsets and generate debug // symbols for Environment, which assumes that the position of members in // memory are predictable. For more information please refer to - // `doc/guides/node-postmortem-support.md` + // `doc/contributing/node-postmortem-support.md` friend int GenDebugSymbols(); HandleWrapQueue handle_wrap_queue_; ReqWrapQueue req_wrap_queue_; diff --git a/src/handle_wrap.h b/src/handle_wrap.h index ff25db2d919..2e06829b7bd 100644 --- a/src/handle_wrap.h +++ b/src/handle_wrap.h @@ -106,7 +106,7 @@ class HandleWrap : public AsyncWrap { // class because it is used by src/node_postmortem_metadata.cc to calculate // offsets and generate debug symbols for HandleWrap, which assumes that the // position of members in memory are predictable. For more information please - // refer to `doc/guides/node-postmortem-support.md` + // refer to `doc/contributing/node-postmortem-support.md` friend int GenDebugSymbols(); ListNode<HandleWrap> handle_wrap_queue_; enum { kInitialized, kClosing, kClosed } state_; diff --git a/src/req_wrap.h b/src/req_wrap.h index 5d7fcb42d01..611e438275a 100644 --- a/src/req_wrap.h +++ b/src/req_wrap.h @@ -66,7 +66,7 @@ class ReqWrap : public AsyncWrap, public ReqWrapBase { // members in memory are predictable. sizeof(req_) depends on the type of T, // so req_wrap_queue_ would no longer be at a fixed offset if it came after // req_. For more information please refer to - // `doc/guides/node-postmortem-support.md` + // `doc/contributing/node-postmortem-support.md` T req_; }; |