From c4a5db6e2c0f4446268e4c8113cb84bb92f66f44 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 10 Dec 2021 20:26:27 -0800 Subject: [PATCH] doc: move style guide to findable location MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move the style guide to doc/README.md so people might find it. The current location is easily overlooked, as is evidenced by https://github.com/nodejs/node/pull/41025 PR-URL: https://github.com/nodejs/node/pull/41119 Reviewed-By: Michaël Zasso Reviewed-By: Derek Lewis Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: James M Snell --- doc/{guides/doc-style-guide.md => README.md} | 2 +- doc/guides/contributing/pull-requests.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename doc/{guides/doc-style-guide.md => README.md} (99%) diff --git a/doc/guides/doc-style-guide.md b/doc/README.md similarity index 99% rename from doc/guides/doc-style-guide.md rename to doc/README.md index 60adcbf4e6b7f1..a0f050ecd5cfc8 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/README.md @@ -109,7 +109,7 @@ For topics not covered here, refer to the [Microsoft Writing Style Guide][]. [Use sentence-style capitalization for headings]: https://docs.microsoft.com/en-us/style-guide/scannable-content/headings#formatting-headings [Use serial commas]: https://docs.microsoft.com/en-us/style-guide/punctuation/commas [`remark-preset-lint-node`]: https://github.com/nodejs/remark-preset-lint-node -[doctools README]: ../../tools/doc/README.md +[doctools README]: ../tools/doc/README.md [info string]: https://github.github.com/gfm/#info-string [language]: https://github.com/highlightjs/highlight.js/blob/HEAD/SUPPORTED_LANGUAGES.md [plugin]: https://editorconfig.org/#download diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 0028969fa87b4b..352c6eba39e04e 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -121,7 +121,7 @@ If you are modifying code, please be sure to run `make lint` (or code style guide. Any documentation you write (including code comments and API documentation) -should follow the [Style Guide](../doc-style-guide.md). Code samples +should follow the [Style Guide](../../README.md). Code samples included in the API docs will also be checked when running `make lint` (or `vcbuild.bat lint` on Windows). If you are adding to or deprecating an API, add or change the appropriate YAML documentation. Use `REPLACEME` for the