diff options
| author | Rich Trott <rtrott@gmail.com> | 2021-12-10 20:26:27 -0800 |
|---|---|---|
| committer | Danielle Adams <adamzdanielle@gmail.com> | 2021-12-13 17:14:19 -0500 |
| commit | db26bdb01138d03464e099d0aed3f3702332c4cb (patch) | |
| tree | 6b4ee17fd72e7de7bcd8323bd26045dd9b911deb | |
| parent | 348707fca6662526b3bae40c79887e80f853ed9f (diff) | |
| download | node-new-db26bdb01138d03464e099d0aed3f3702332c4cb.tar.gz | |
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
PR-URL: https://github.com/nodejs/node/pull/41119
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
| -rw-r--r-- | doc/README.md (renamed from doc/guides/doc-style-guide.md) | 2 | ||||
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/guides/doc-style-guide.md b/doc/README.md index 60adcbf4e6..a0f050ecd5 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 0028969fa8..352c6eba39 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 |