Skip to content

Commit f6b5b8d

Browse files
mhdawsonBethGriggs
authored andcommitted
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: #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>
1 parent 6370b4d commit f6b5b8d

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β€Ž

Lines changed: 2 additions & 4 deletions
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β€Ž

Lines changed: 1 addition & 1 deletion

β€Ž.github/workflows/auto-start-ci.ymlβ€Ž

Lines changed: 1 addition & 1 deletion
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β€Ž

Lines changed: 13 additions & 13 deletions

β€ŽGOVERNANCE.mdβ€Ž

Lines changed: 2 additions & 2 deletions

β€ŽMakefileβ€Ž

Lines changed: 2 additions & 2 deletions
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β€Ž

Lines changed: 3 additions & 3 deletions

β€Žbenchmark/README.mdβ€Ž

Lines changed: 4 additions & 4 deletions

β€Ždeps/openssl/README.mdβ€Ž

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
Β (0)