Commit f6b5b8d
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
53 files changed
Lines changed: 58 additions & 60 deletions
File tree
- .github
- workflows
- benchmark
- deps/openssl
- doc/contributing
- doc_img
- src
- test
- tools/icu
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -13,9 +13,7 @@ | |||
| 13 | 13 | /CODE_OF_CONDUCT.md @nodejs/tsc | |
| 14 | 14 | /CONTRIBUTING.md @nodejs/tsc | |
| 15 | 15 | /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 | ||
| 19 | 17 | ||
| 20 | 18 | # streams | |
| 21 | 19 | ||
@@ -88,7 +86,7 @@ | |||
| 88 | 86 | ||
| 89 | 87 | /src/node_api* @nodejs/node-api | |
| 90 | 88 | /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 | ||
| 92 | 90 | /doc/api/n-api.md @nodejs/node-api | |
| 93 | 91 | ||
| 94 | 92 | # gyp | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,7 +5,7 @@ on: | |||
| 5 | 5 | # Runs every five minutes (fastest the scheduler can run). Five minutes is | |
| 6 | 6 | # optimistic, it can take longer to run. | |
| 7 | 7 | # To understand why `schedule` is used instead of other events, refer to | |
| 8 | - # ./doc/guides/commit-queue.md | ||
| 8 | + # ./doc/contributing/commit-queue.md | ||
| 9 | 9 | - cron: "*/5 * * * *" | |
| 10 | 10 | ||
| 11 | 11 | env: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -997,14 +997,14 @@ endif | |||
| 997 | 997 | .PHONY: release-only | |
| 998 | 998 | release-only: check-xz | |
| 999 | 999 | @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' ; \ | ||
| 1001 | 1001 | REPLACEMES="$(shell grep -l REPLACEME doc/api/*.md)" ; \ | |
| 1002 | 1002 | echo "$$REPLACEMES\n" | tr " " "\n" ; \ | |
| 1003 | 1003 | exit 1 ; \ | |
| 1004 | 1004 | fi | |
| 1005 | 1005 | @if [ "$(DISTTYPE)" = "release" ] && \ | |
| 1006 | 1006 | `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)' ; \ | ||
| 1008 | 1008 | exit 1 ; \ | |
| 1009 | 1009 | fi | |
| 1010 | 1010 | @if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \ | |
0 commit comments