From a8cd2dc1938dd9dfed051b6822ea678dea05e328 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 8 Dec 2021 19:54:49 -0800 Subject: [PATCH] doc: move style guide to findable location 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 --- doc/guides/{doc-style-guide.md => README.md} | 0 doc/guides/contributing/pull-requests.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename doc/guides/{doc-style-guide.md => README.md} (100%) diff --git a/doc/guides/doc-style-guide.md b/doc/guides/README.md similarity index 100% rename from doc/guides/doc-style-guide.md rename to doc/guides/README.md 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