Skip to content

Commit a199387

Browse files
committed
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 <[email protected]> PR-URL: #41408 Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Mary Marchini <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 65910c0 commit a199387

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+58
-60
lines changed

.github/CODEOWNERS

+2-4
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
/CODE_OF_CONDUCT.md @nodejs/tsc
1414
/CONTRIBUTING.md @nodejs/tsc
1515
/LICENSE @nodejs/tsc
16-
/doc/guides/contributing/*.md @nodejs/tsc
17-
/doc/guides/collaborator-guide.md @nodejs/tsc
18-
/doc/guides/offboarding.md @nodejs/tsc
16+
/doc/contributing/*.md @nodejs/tsc
1917

2018
# streams
2119

@@ -88,7 +86,7 @@
8886

8987
/src/node_api* @nodejs/node-api
9088
/src/js_native_api* @nodejs/node-api
91-
/doc/guides/adding-new-napi-api.md @nodejs/node-api
89+
/doc/contributing/adding-new-napi-api.md @nodejs/node-api
9290
/doc/api/n-api.md @nodejs/node-api
9391

9492
# gyp

.github/PULL_REQUEST_TEMPLATE.md

+1-1

.github/workflows/auto-start-ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
# Runs every five minutes (fastest the scheduler can run). Five minutes is
66
# optimistic, it can take longer to run.
77
# To understand why `schedule` is used instead of other events, refer to
8-
# ./doc/guides/commit-queue.md
8+
# ./doc/contributing/commit-queue.md
99
- cron: "*/5 * * * *"
1010

1111
env:

CONTRIBUTING.md

+13-13

GOVERNANCE.md

+2-2

Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -997,14 +997,14 @@ endif
997997
.PHONY: release-only
998998
release-only: check-xz
999999
@if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \
1000-
echo 'Please update REPLACEME tags in the following doc/api/*.md files (See doc/guides/releases.md):\n' ; \
1000+
echo 'Please update REPLACEME tags in the following doc/api/*.md files (See doc/contributing/releases.md):\n' ; \
10011001
REPLACEMES="$(shell grep -l REPLACEME doc/api/*.md)" ; \
10021002
echo "$$REPLACEMES\n" | tr " " "\n" ; \
10031003
exit 1 ; \
10041004
fi
10051005
@if [ "$(DISTTYPE)" = "release" ] && \
10061006
`grep -q DEP...X doc/api/deprecations.md`; then \
1007-
echo 'Please update DEP...X in doc/api/deprecations.md (See doc/guides/releases.md)' ; \
1007+
echo 'Please update DEP...X in doc/api/deprecations.md (See doc/contributing/releases.md)' ; \
10081008
exit 1 ; \
10091009
fi
10101010
@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \

README.md

+3-3

benchmark/README.md

+4-4

deps/openssl/README.md

+1-1

doc/guides/collaborator-guide.md doc/contributing/collaborator-guide.md

+3-3

doc/guides/cpp-style-guide.md doc/contributing/cpp-style-guide.md

+1-1
File renamed without changes.

doc/guides/maintaining-c-ares.md doc/contributing/maintaining-c-ares.md

+1-1

doc/guides/maintaining-zlib.md doc/contributing/maintaining-zlib.md

+1-1

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

+8-8

doc/guides/releases.md doc/contributing/releases.md

+1-1

onboarding.md

+5-5

src/README.md

+1-1

src/base_object.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ class BaseObject : public MemoryRetainer {
171171
// class because it is used by src/node_postmortem_metadata.cc to calculate
172172
// offsets and generate debug symbols for BaseObject, which assumes that the
173173
// position of members in memory are predictable. For more information please
174-
// refer to `doc/guides/node-postmortem-support.md`
174+
// refer to `doc/contributing/node-postmortem-support.md`
175175
friend int GenDebugSymbols();
176176
friend class CleanupHookCallback;
177177
template <typename T, bool kIsWeak>

src/env.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1561,7 +1561,7 @@ class Environment : public MemoryRetainer {
15611561
// src/node_postmortem_metadata.cc to calculate offsets and generate debug
15621562
// symbols for Environment, which assumes that the position of members in
15631563
// memory are predictable. For more information please refer to
1564-
// `doc/guides/node-postmortem-support.md`
1564+
// `doc/contributing/node-postmortem-support.md`
15651565
friend int GenDebugSymbols();
15661566
HandleWrapQueue handle_wrap_queue_;
15671567
ReqWrapQueue req_wrap_queue_;

src/handle_wrap.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ class HandleWrap : public AsyncWrap {
106106
// class because it is used by src/node_postmortem_metadata.cc to calculate
107107
// offsets and generate debug symbols for HandleWrap, which assumes that the
108108
// position of members in memory are predictable. For more information please
109-
// refer to `doc/guides/node-postmortem-support.md`
109+
// refer to `doc/contributing/node-postmortem-support.md`
110110
friend int GenDebugSymbols();
111111
ListNode<HandleWrap> handle_wrap_queue_;
112112
enum { kInitialized, kClosing, kClosed } state_;

src/req_wrap.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class ReqWrap : public AsyncWrap, public ReqWrapBase {
6666
// members in memory are predictable. sizeof(req_) depends on the type of T,
6767
// so req_wrap_queue_ would no longer be at a fixed offset if it came after
6868
// req_. For more information please refer to
69-
// `doc/guides/node-postmortem-support.md`
69+
// `doc/contributing/node-postmortem-support.md`
7070
T req_;
7171
};
7272

test/README.md

+2-2

tools/icu/README.md

+2-2

0 commit comments

Comments
 (0)