From f6b5b8d5bb2a98985731cefb8437c99a9d6562ec Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 5 Jan 2022 13:26:30 -0500 Subject: [PATCH] doc: make contributing info more discoverable MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 PR-URL: https://github.com/nodejs/node/pull/41408 Reviewed-By: Franziska Hinkelmann Reviewed-By: Michaël Zasso Reviewed-By: Derek Lewis Reviewed-By: Mary Marchini Reviewed-By: James M Snell --- .github/CODEOWNERS | 6 ++-- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/auto-start-ci.yml | 2 +- CONTRIBUTING.md | 26 +++++++++--------- GOVERNANCE.md | 4 +-- Makefile | 4 +-- README.md | 6 ++-- benchmark/README.md | 8 +++--- deps/openssl/README.md | 2 +- .../adding-new-napi-api.md | 0 .../backporting-to-release-lines.md | 0 .../building-node-with-ninja.md | 0 .../contributing/code-of-conduct.md | 0 .../collaborator-guide.md | 6 ++-- doc/{guides => contributing}/commit-queue.md | 0 .../components-in-core.md | 0 .../cpp-style-guide.md | 2 +- .../diagnostic-tooling-support-tiers.md | 0 .../doc_img/compare-boxplot.png | Bin .../doc_img/scatter-plot.png | Bin doc/{guides => contributing}/internal-api.md | 0 .../investigating_native_memory_leak.md | 0 doc/{guides => }/contributing/issues.md | 0 .../maintaining-V8.md | 0 .../maintaining-c-ares.md | 2 +- .../maintaining-icu.md | 0 .../maintaining-npm.md | 0 .../maintaining-openssl.md | 0 .../maintaining-root-certs.md | 0 .../maintaining-the-build-files.md | 0 .../maintaining-zlib.md | 2 +- .../node-postmortem-support.md | 0 doc/{guides => contributing}/offboarding.md | 0 .../contributing/pull-requests.md | 16 +++++------ doc/{guides => contributing}/releases.md | 2 +- .../security-release-process.md | 0 .../security-steward-on-off-boarding.md | 0 .../static-analysis.md | 0 .../strategic-initiatives.md | 0 .../technical-priorities.md | 0 .../technical-values.md | 0 .../using-internal-errors.md | 0 doc/{guides => contributing}/using-symbols.md | 0 .../writing-and-running-benchmarks.md | 0 doc/{guides => contributing}/writing-tests.md | 0 onboarding.md | 10 +++---- src/README.md | 2 +- src/base_object.h | 2 +- src/env.h | 2 +- src/handle_wrap.h | 2 +- src/req_wrap.h | 2 +- test/README.md | 4 +-- tools/icu/README.md | 4 +-- 53 files changed, 58 insertions(+), 60 deletions(-) rename doc/{guides => contributing}/adding-new-napi-api.md (100%) rename doc/{guides => contributing}/backporting-to-release-lines.md (100%) rename doc/{guides => contributing}/building-node-with-ninja.md (100%) rename doc/{guides => }/contributing/code-of-conduct.md (100%) rename doc/{guides => contributing}/collaborator-guide.md (99%) rename doc/{guides => contributing}/commit-queue.md (100%) rename doc/{guides => contributing}/components-in-core.md (100%) rename doc/{guides => contributing}/cpp-style-guide.md (99%) rename doc/{guides => contributing}/diagnostic-tooling-support-tiers.md (100%) rename doc/{guides => contributing}/doc_img/compare-boxplot.png (100%) rename doc/{guides => contributing}/doc_img/scatter-plot.png (100%) rename doc/{guides => contributing}/internal-api.md (100%) rename doc/{guides => contributing}/investigating_native_memory_leak.md (100%) rename doc/{guides => }/contributing/issues.md (100%) rename doc/{guides => contributing}/maintaining-V8.md (100%) rename doc/{guides => contributing}/maintaining-c-ares.md (96%) rename doc/{guides => contributing}/maintaining-icu.md (100%) rename doc/{guides => contributing}/maintaining-npm.md (100%) rename doc/{guides => contributing}/maintaining-openssl.md (100%) rename doc/{guides => contributing}/maintaining-root-certs.md (100%) rename doc/{guides => contributing}/maintaining-the-build-files.md (100%) rename doc/{guides => contributing}/maintaining-zlib.md (93%) rename doc/{guides => contributing}/node-postmortem-support.md (100%) rename doc/{guides => contributing}/offboarding.md (100%) rename doc/{guides => }/contributing/pull-requests.md (98%) rename doc/{guides => contributing}/releases.md (99%) rename doc/{guides => contributing}/security-release-process.md (100%) rename doc/{guides => contributing}/security-steward-on-off-boarding.md (100%) rename doc/{guides => contributing}/static-analysis.md (100%) rename doc/{guides => contributing}/strategic-initiatives.md (100%) rename doc/{guides => contributing}/technical-priorities.md (100%) rename doc/{guides => contributing}/technical-values.md (100%) rename doc/{guides => contributing}/using-internal-errors.md (100%) rename doc/{guides => contributing}/using-symbols.md (100%) rename doc/{guides => contributing}/writing-and-running-benchmarks.md (100%) rename doc/{guides => contributing}/writing-tests.md (100%) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 393964d59c52cb..4170038a0ac0fc 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,9 +13,7 @@ /CODE_OF_CONDUCT.md @nodejs/tsc /CONTRIBUTING.md @nodejs/tsc /LICENSE @nodejs/tsc -/doc/guides/contributing/*.md @nodejs/tsc -/doc/guides/collaborator-guide.md @nodejs/tsc -/doc/guides/offboarding.md @nodejs/tsc +/doc/contributing/*.md @nodejs/tsc # streams @@ -88,7 +86,7 @@ /src/node_api* @nodejs/node-api /src/js_native_api* @nodejs/node-api -/doc/guides/adding-new-napi-api.md @nodejs/node-api +/doc/contributing/adding-new-napi-api.md @nodejs/node-api /doc/api/n-api.md @nodejs/node-api # gyp diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f99a8abb394d14..fe46bf4deadeb7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,7 @@ Before submitting a pull request, please read https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md. Commit message formatting guidelines: -https://github.com/nodejs/node/blob/HEAD/doc/guides/contributing/pull-requests.md#commit-message-guidelines +https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines For code changes: 1. Include tests for any bug fixes or new features. diff --git a/.github/workflows/auto-start-ci.yml b/.github/workflows/auto-start-ci.yml index 6c392c5a5a6f5b..632fdc0a970ceb 100644 --- a/.github/workflows/auto-start-ci.yml +++ b/.github/workflows/auto-start-ci.yml @@ -5,7 +5,7 @@ on: # Runs every five minutes (fastest the scheduler can run). Five minutes is # optimistic, it can take longer to run. # To understand why `schedule` is used instead of other events, refer to - # ./doc/guides/commit-queue.md + # ./doc/contributing/commit-queue.md - cron: "*/5 * * * *" env: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0d3f4f648ef96..f815adbb1fc34b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,28 +5,28 @@ * [Pull Requests](#pull-requests) * [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin) -## [Code of Conduct](./doc/guides/contributing/code-of-conduct.md) +## [Code of Conduct](./doc/contributing/code-of-conduct.md) The Node.js project has a [Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md) to which all contributors must adhere. -See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of-conduct.md). +See [details on our policy on Code of Conduct](./doc/contributing/code-of-conduct.md). -## [Issues](./doc/guides/contributing/issues.md) +## [Issues](./doc/contributing/issues.md) -* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help) -* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics) -* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report) -* [Triaging a Bug Report](./doc/guides/contributing/issues.md#triaging-a-bug-report) +* [Asking for General Help](./doc/contributing/issues.md#asking-for-general-help) +* [Discussing non-technical topics](./doc/contributing/issues.md#discussing-non-technical-topics) +* [Submitting a Bug Report](./doc/contributing/issues.md#submitting-a-bug-report) +* [Triaging a Bug Report](./doc/contributing/issues.md#triaging-a-bug-report) -## [Pull Requests](./doc/guides/contributing/pull-requests.md) +## [Pull Requests](./doc/contributing/pull-requests.md) -* [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies) -* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment) -* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes) -* [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests) -* [Notes](./doc/guides/contributing/pull-requests.md#notes) +* [Dependencies](./doc/contributing/pull-requests.md#dependencies) +* [Setting up your local environment](./doc/contributing/pull-requests.md#setting-up-your-local-environment) +* [The Process of Making Changes](./doc/contributing/pull-requests.md#the-process-of-making-changes) +* [Reviewing Pull Requests](./doc/contributing/pull-requests.md#reviewing-pull-requests) +* [Notes](./doc/contributing/pull-requests.md#notes) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index fb74525eb0ee79..f5f3ffa015ced7 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -25,7 +25,7 @@ Triagers are given the "Triage" GitHub role and have: See: * [List of triagers](./README.md#triagers) -* [A guide for triagers](./doc/guides/contributing/issues.md#triaging-a-bug-report) +* [A guide for triagers](./doc/contributing/issues.md#triaging-a-bug-report) ## Collaborators @@ -54,7 +54,7 @@ result in collaborators removing their opposition. See: * [List of collaborators](./README.md#current-project-team-members) -* [A guide for collaborators](./doc/guides/collaborator-guide.md) +* [A guide for collaborators](./doc/contributing/collaborator-guide.md) ### Collaborator activities diff --git a/Makefile b/Makefile index 7c3e122c206d2e..8b1b1f16014cd9 100644 --- a/Makefile +++ b/Makefile @@ -997,14 +997,14 @@ endif .PHONY: release-only release-only: check-xz @if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \ - echo 'Please update REPLACEME tags in the following doc/api/*.md files (See doc/guides/releases.md):\n' ; \ + echo 'Please update REPLACEME tags in the following doc/api/*.md files (See doc/contributing/releases.md):\n' ; \ REPLACEMES="$(shell grep -l REPLACEME doc/api/*.md)" ; \ echo "$$REPLACEMES\n" | tr " " "\n" ; \ exit 1 ; \ fi @if [ "$(DISTTYPE)" = "release" ] && \ `grep -q DEP...X doc/api/deprecations.md`; then \ - echo 'Please update DEP...X in doc/api/deprecations.md (See doc/guides/releases.md)' ; \ + echo 'Please update DEP...X in doc/api/deprecations.md (See doc/contributing/releases.md)' ; \ exit 1 ; \ fi @if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \ diff --git a/README.md b/README.md index 53de55288a06a9..93f803420eecf6 100644 --- a/README.md +++ b/README.md @@ -635,7 +635,7 @@ For information about the governance of the Node.js project, see -Collaborators follow the [Collaborator Guide](./doc/guides/collaborator-guide.md) in +Collaborators follow the [Collaborator Guide](./doc/contributing/collaborator-guide.md) in maintaining the Node.js project. ### Triagers @@ -741,6 +741,6 @@ license text. [Contributing to the project]: CONTRIBUTING.md [Node.js Website]: https://nodejs.org/ [OpenJS Foundation]: https://openjsf.org/ -[Strategic initiatives]: doc/guides/strategic-initiatives.md -[Technical values and prioritization]: doc/guides/technical-values.md +[Strategic initiatives]: doc/contributing/strategic-initiatives.md +[Technical values and prioritization]: doc/contributing/technical-values.md [Working Groups]: https://github.com/nodejs/TSC/blob/HEAD/WORKING_GROUPS.md diff --git a/benchmark/README.md b/benchmark/README.md index e40972fde08ac9..710731b3c9f0fd 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -5,7 +5,7 @@ of different Node.js implementations and different ways of writing JavaScript run by the built-in JavaScript engine. For a detailed guide on how to write and run benchmarks in this -directory, see [the guide on benchmarks](../doc/guides/writing-and-running-benchmarks.md). +directory, see [the guide on benchmarks](../doc/contributing/writing-and-running-benchmarks.md). ## Table of Contents @@ -77,17 +77,17 @@ writing benchmarks. ### `createBenchmark(fn, configs[, options])` -See [the guide on writing benchmarks](../doc/guides/writing-and-running-benchmarks.md#basics-of-a-benchmark). +See [the guide on writing benchmarks](../doc/contributing/writing-and-running-benchmarks.md#basics-of-a-benchmark). ### `default_http_benchmarker` The default benchmarker used to run HTTP benchmarks. -See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark). +See [the guide on writing HTTP benchmarks](../doc/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark). ### `PORT` The default port used to run HTTP benchmarks. -See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark). +See [the guide on writing HTTP benchmarks](../doc/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark). ### `sendResult(data)` diff --git a/deps/openssl/README.md b/deps/openssl/README.md index bd0ad0c9949848..225bfba8e7425c 100644 --- a/deps/openssl/README.md +++ b/deps/openssl/README.md @@ -77,4 +77,4 @@ Please refer [config/opensslconf_asm.h](config/opensslconf_asm.h) for details. ### Upgrading OpenSSL -Please refer to [maintaining-openssl](../../doc/guides/maintaining-openssl.md). +Please refer to [maintaining-openssl](../../doc/contributing/maintaining-openssl.md). diff --git a/doc/guides/adding-new-napi-api.md b/doc/contributing/adding-new-napi-api.md similarity index 100% rename from doc/guides/adding-new-napi-api.md rename to doc/contributing/adding-new-napi-api.md diff --git a/doc/guides/backporting-to-release-lines.md b/doc/contributing/backporting-to-release-lines.md similarity index 100% rename from doc/guides/backporting-to-release-lines.md rename to doc/contributing/backporting-to-release-lines.md diff --git a/doc/guides/building-node-with-ninja.md b/doc/contributing/building-node-with-ninja.md similarity index 100% rename from doc/guides/building-node-with-ninja.md rename to doc/contributing/building-node-with-ninja.md diff --git a/doc/guides/contributing/code-of-conduct.md b/doc/contributing/code-of-conduct.md similarity index 100% rename from doc/guides/contributing/code-of-conduct.md rename to doc/contributing/code-of-conduct.md diff --git a/doc/guides/collaborator-guide.md b/doc/contributing/collaborator-guide.md similarity index 99% rename from doc/guides/collaborator-guide.md rename to doc/contributing/collaborator-guide.md index 9911acdd973265..77e88f4a4571f6 100644 --- a/doc/guides/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -408,7 +408,7 @@ For pull requests introducing new core modules: Node-API provides an ABI-stable API guaranteed for future Node.js versions. Node-API additions call for unusual care and scrutiny. If a change adds to `node_api.h`, `js_native_api.h`, `node_api_types.h`, or `js_native_api_types.h`, -consult [the relevant guide](https://github.com/nodejs/node/blob/HEAD/doc/guides/adding-new-napi-api.md). +consult [the relevant guide](https://github.com/nodejs/node/blob/HEAD/doc/contributing/adding-new-napi-api.md). ### Deprecations @@ -558,7 +558,7 @@ $ git checkout master ``` Update the tree (assumes your repository is set up as detailed in -[CONTRIBUTING.md](./contributing/pull-requests.md#step-1-fork)): +[CONTRIBUTING.md](./pull-requests.md#step-1-fork)): ```text $ git fetch upstream @@ -925,7 +925,7 @@ need to be attached anymore, as only important bugfixes will be included. [`--throw-deprecation`]: ../api/cli.md#--throw-deprecation [`node-core-utils`]: https://github.com/nodejs/node-core-utils [backporting guide]: backporting-to-release-lines.md -[commit message guidelines]: contributing/pull-requests.md#commit-message-guidelines +[commit message guidelines]: pull-requests.md#commit-message-guidelines [commit-example]: https://github.com/nodejs/node/commit/b636ba8186 [commit-queue.md]: ./commit-queue.md [git-email]: https://help.github.com/articles/setting-your-commit-email-address-in-git/ diff --git a/doc/guides/commit-queue.md b/doc/contributing/commit-queue.md similarity index 100% rename from doc/guides/commit-queue.md rename to doc/contributing/commit-queue.md diff --git a/doc/guides/components-in-core.md b/doc/contributing/components-in-core.md similarity index 100% rename from doc/guides/components-in-core.md rename to doc/contributing/components-in-core.md diff --git a/doc/guides/cpp-style-guide.md b/doc/contributing/cpp-style-guide.md similarity index 99% rename from doc/guides/cpp-style-guide.md rename to doc/contributing/cpp-style-guide.md index 0de0d2ec5baeba..64d0efee911e9d 100644 --- a/doc/guides/cpp-style-guide.md +++ b/doc/contributing/cpp-style-guide.md @@ -403,5 +403,5 @@ even `try` and `catch` **will** break. [Run Time Type Information]: https://en.wikipedia.org/wiki/Run-time_type_information [aliased_buffer.h]: https://github.com/nodejs/node/blob/HEAD/src/aliased_buffer.h#L12 [cppref_auto_ptr]: https://en.cppreference.com/w/cpp/memory/auto_ptr -[errors]: https://github.com/nodejs/node/blob/HEAD/doc/guides/using-internal-errors.md +[errors]: https://github.com/nodejs/node/blob/HEAD/doc/contributing/using-internal-errors.md [without C++ exception handling]: https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_exceptions.html#intro.using.exception.no diff --git a/doc/guides/diagnostic-tooling-support-tiers.md b/doc/contributing/diagnostic-tooling-support-tiers.md similarity index 100% rename from doc/guides/diagnostic-tooling-support-tiers.md rename to doc/contributing/diagnostic-tooling-support-tiers.md diff --git a/doc/guides/doc_img/compare-boxplot.png b/doc/contributing/doc_img/compare-boxplot.png similarity index 100% rename from doc/guides/doc_img/compare-boxplot.png rename to doc/contributing/doc_img/compare-boxplot.png diff --git a/doc/guides/doc_img/scatter-plot.png b/doc/contributing/doc_img/scatter-plot.png similarity index 100% rename from doc/guides/doc_img/scatter-plot.png rename to doc/contributing/doc_img/scatter-plot.png diff --git a/doc/guides/internal-api.md b/doc/contributing/internal-api.md similarity index 100% rename from doc/guides/internal-api.md rename to doc/contributing/internal-api.md diff --git a/doc/guides/investigating_native_memory_leak.md b/doc/contributing/investigating_native_memory_leak.md similarity index 100% rename from doc/guides/investigating_native_memory_leak.md rename to doc/contributing/investigating_native_memory_leak.md diff --git a/doc/guides/contributing/issues.md b/doc/contributing/issues.md similarity index 100% rename from doc/guides/contributing/issues.md rename to doc/contributing/issues.md diff --git a/doc/guides/maintaining-V8.md b/doc/contributing/maintaining-V8.md similarity index 100% rename from doc/guides/maintaining-V8.md rename to doc/contributing/maintaining-V8.md diff --git a/doc/guides/maintaining-c-ares.md b/doc/contributing/maintaining-c-ares.md similarity index 96% rename from doc/guides/maintaining-c-ares.md rename to doc/contributing/maintaining-c-ares.md index 968b96f25820d1..64f29674c4e8a6 100644 --- a/doc/guides/maintaining-c-ares.md +++ b/doc/contributing/maintaining-c-ares.md @@ -62,5 +62,5 @@ Commit the changes with a message like ```text deps: update c-ares to x.y.z -Updated as described in doc/guides/maintaining-c-ares.md. +Updated as described in doc/contributing/maintaining-c-ares.md. ``` diff --git a/doc/guides/maintaining-icu.md b/doc/contributing/maintaining-icu.md similarity index 100% rename from doc/guides/maintaining-icu.md rename to doc/contributing/maintaining-icu.md diff --git a/doc/guides/maintaining-npm.md b/doc/contributing/maintaining-npm.md similarity index 100% rename from doc/guides/maintaining-npm.md rename to doc/contributing/maintaining-npm.md diff --git a/doc/guides/maintaining-openssl.md b/doc/contributing/maintaining-openssl.md similarity index 100% rename from doc/guides/maintaining-openssl.md rename to doc/contributing/maintaining-openssl.md diff --git a/doc/guides/maintaining-root-certs.md b/doc/contributing/maintaining-root-certs.md similarity index 100% rename from doc/guides/maintaining-root-certs.md rename to doc/contributing/maintaining-root-certs.md diff --git a/doc/guides/maintaining-the-build-files.md b/doc/contributing/maintaining-the-build-files.md similarity index 100% rename from doc/guides/maintaining-the-build-files.md rename to doc/contributing/maintaining-the-build-files.md diff --git a/doc/guides/maintaining-zlib.md b/doc/contributing/maintaining-zlib.md similarity index 93% rename from doc/guides/maintaining-zlib.md rename to doc/contributing/maintaining-zlib.md index 4dba29bacf9127..caed2534c69c3b 100644 --- a/doc/guides/maintaining-zlib.md +++ b/doc/contributing/maintaining-zlib.md @@ -32,5 +32,5 @@ Commit the changes with a message like ```text deps: update zlib to upstream d7f3ca9 -Updated as described in doc/guides/maintaining-zlib.md. +Updated as described in doc/contributing/maintaining-zlib.md. ``` diff --git a/doc/guides/node-postmortem-support.md b/doc/contributing/node-postmortem-support.md similarity index 100% rename from doc/guides/node-postmortem-support.md rename to doc/contributing/node-postmortem-support.md diff --git a/doc/guides/offboarding.md b/doc/contributing/offboarding.md similarity index 100% rename from doc/guides/offboarding.md rename to doc/contributing/offboarding.md diff --git a/doc/guides/contributing/pull-requests.md b/doc/contributing/pull-requests.md similarity index 98% rename from doc/guides/contributing/pull-requests.md rename to doc/contributing/pull-requests.md index 95024008645916..00868c4bfc91d9 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/contributing/pull-requests.md @@ -137,8 +137,8 @@ added: REPLACEME ``` For contributing C++ code, you may want to look at the -[C++ Style Guide](../cpp-style-guide.md), as well as the -[README of `src/`](../../../src/README.md) for an overview of Node.js +[C++ Style Guide](cpp-style-guide.md), as well as the +[README of `src/`](../../src/README.md) for an overview of Node.js C++ internals. ### Step 4: Commit @@ -586,16 +586,16 @@ You can find the full list of supported subsystems in the [nodejs/core-validate-commit][] repository. More than one subsystem may be valid for any particular issue or pull request. -[Building guide]: ../../../BUILDING.md +[Building guide]: ../../BUILDING.md [CI (Continuous Integration) test run]: #ci-testing [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md -[Onboarding guide]: ../../../onboarding.md +[Onboarding guide]: ../../onboarding.md [approved]: #getting-approvals-for-your-pull-request -[benchmark results]: ../writing-and-running-benchmarks.md -[collaborator guide]: ../collaborator-guide.md -[guide for writing tests in Node.js]: ../writing-tests.md +[benchmark results]: writing-and-running-benchmarks.md +[collaborator guide]: collaborator-guide.md +[guide for writing tests in Node.js]: writing-tests.md [hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment [https://ci.nodejs.org/]: https://ci.nodejs.org/ [nodejs/core-validate-commit]: https://github.com/nodejs/core-validate-commit/blob/main/lib/rules/subsystem.js [pull request template]: https://raw.githubusercontent.com/nodejs/node/HEAD/.github/PULL_REQUEST_TEMPLATE.md -[running tests]: ../../../BUILDING.md#running-tests +[running tests]: ../../BUILDING.md#running-tests diff --git a/doc/guides/releases.md b/doc/contributing/releases.md similarity index 99% rename from doc/guides/releases.md rename to doc/contributing/releases.md index a3a3b51f8bf85f..042f8283744fd8 100644 --- a/doc/guides/releases.md +++ b/doc/contributing/releases.md @@ -202,7 +202,7 @@ When cherry-picking commits, if there are simple conflicts you can resolve them. Otherwise, add the `backport-requested-vN.x` label to the original PR and post a comment stating that it does not land cleanly and will require a backport PR. You can refer the owner of the PR to the "[Backporting to Release -Lines](https://github.com/nodejs/node/blob/HEAD/doc/guides/backporting-to-release-lines.md)" guide. +Lines](https://github.com/nodejs/node/blob/HEAD/doc/contributing/backporting-to-release-lines.md)" guide. If commits were cherry-picked in this step, check that the test still pass. diff --git a/doc/guides/security-release-process.md b/doc/contributing/security-release-process.md similarity index 100% rename from doc/guides/security-release-process.md rename to doc/contributing/security-release-process.md diff --git a/doc/guides/security-steward-on-off-boarding.md b/doc/contributing/security-steward-on-off-boarding.md similarity index 100% rename from doc/guides/security-steward-on-off-boarding.md rename to doc/contributing/security-steward-on-off-boarding.md diff --git a/doc/guides/static-analysis.md b/doc/contributing/static-analysis.md similarity index 100% rename from doc/guides/static-analysis.md rename to doc/contributing/static-analysis.md diff --git a/doc/guides/strategic-initiatives.md b/doc/contributing/strategic-initiatives.md similarity index 100% rename from doc/guides/strategic-initiatives.md rename to doc/contributing/strategic-initiatives.md diff --git a/doc/guides/technical-priorities.md b/doc/contributing/technical-priorities.md similarity index 100% rename from doc/guides/technical-priorities.md rename to doc/contributing/technical-priorities.md diff --git a/doc/guides/technical-values.md b/doc/contributing/technical-values.md similarity index 100% rename from doc/guides/technical-values.md rename to doc/contributing/technical-values.md diff --git a/doc/guides/using-internal-errors.md b/doc/contributing/using-internal-errors.md similarity index 100% rename from doc/guides/using-internal-errors.md rename to doc/contributing/using-internal-errors.md diff --git a/doc/guides/using-symbols.md b/doc/contributing/using-symbols.md similarity index 100% rename from doc/guides/using-symbols.md rename to doc/contributing/using-symbols.md diff --git a/doc/guides/writing-and-running-benchmarks.md b/doc/contributing/writing-and-running-benchmarks.md similarity index 100% rename from doc/guides/writing-and-running-benchmarks.md rename to doc/contributing/writing-and-running-benchmarks.md diff --git a/doc/guides/writing-tests.md b/doc/contributing/writing-tests.md similarity index 100% rename from doc/guides/writing-tests.md rename to doc/contributing/writing-tests.md diff --git a/onboarding.md b/onboarding.md index eef5ee41e7065e..f17b24c50f15ba 100644 --- a/onboarding.md +++ b/onboarding.md @@ -253,15 +253,15 @@ needs to be pointed out separately during the onboarding. access to the projects coverity project as outlined in [static-analysis][]. [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md -[Labels]: doc/guides/collaborator-guide.md#labels -[Landing pull requests]: doc/guides/collaborator-guide.md#landing-pull-requests +[Labels]: doc/contributing/collaborator-guide.md#labels +[Landing pull requests]: doc/contributing/collaborator-guide.md#landing-pull-requests [Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/ -[`author-ready`]: doc/guides/collaborator-guide.md#author-ready-pull-requests +[`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests [`core-validate-commit`]: https://github.com/nodejs/core-validate-commit [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md [`node-core-utils`]: https://github.com/nodejs/node-core-utils [set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials -[static-analysis]: doc/guides/static-analysis.md +[static-analysis]: doc/contributing/static-analysis.md [two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/ [using a TOTP mobile app]: https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/ -[who-to-cc]: doc/guides/collaborator-guide.md#who-to-cc-in-the-issue-tracker +[who-to-cc]: doc/contributing/collaborator-guide.md#who-to-cc-in-the-issue-tracker diff --git a/src/README.md b/src/README.md index 25c63e2f8cc3e5..623c3774971b6e 100644 --- a/src/README.md +++ b/src/README.md @@ -1024,7 +1024,7 @@ static void GetUserInfo(const FunctionCallbackInfo& 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 d46a0f216009c6..1c63da92fd80c0 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 diff --git a/src/env.h b/src/env.h index 17aa6c7222d19a..7aa5822abf11f1 100644 --- a/src/env.h +++ b/src/env.h @@ -1560,7 +1560,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 ff25db2d9194a3..2e06829b7bd885 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 handle_wrap_queue_; enum { kInitialized, kClosing, kClosed } state_; diff --git a/src/req_wrap.h b/src/req_wrap.h index 5d7fcb42d01148..611e438275a13a 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_; }; diff --git a/test/README.md b/test/README.md index 0534d0dfb81774..121ecc89b54225 100644 --- a/test/README.md +++ b/test/README.md @@ -3,10 +3,10 @@ This directory contains code and data used to test the Node.js implementation. For a detailed guide on how to write tests in this -directory, see [the guide on writing tests](../doc/guides/writing-tests.md). +directory, see [the guide on writing tests](../doc/contributing/writing-tests.md). On how to run tests in this directory, see -[the contributing guide](../doc/guides/contributing/pull-requests.md#step-6-test). +[the contributing guide](../doc/contributing/pull-requests.md#step-6-test). For the tests to run on Windows, be sure to clone Node.js source code with the `autocrlf` git config flag set to true. diff --git a/tools/icu/README.md b/tools/icu/README.md index 544f4bf2152ff0..2e908e2cf44750 100644 --- a/tools/icu/README.md +++ b/tools/icu/README.md @@ -27,8 +27,8 @@ Note: ## See Also -* [docs/guides/maintaining-icu.md](../../doc/guides/maintaining-icu.md) for - information on maintaining ICU in Node.js +* [docs/guides/maintaining-icu.md](../../doc/contributing/maintaining-icu.md) + for information on maintaining ICU in Node.js * [docs/api/intl.md](../../doc/api/intl.md) for information on the internationalization-related APIs in Node.js