Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
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
#41025

PR-URL: #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>
  • Loading branch information
Trott authored and danielleadams committed Dec 13, 2021
1 parent 348707f commit db26bdb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/guides/doc-style-guide.md → doc/README.md
Expand Up @@ -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
2 changes: 1 addition & 1 deletion doc/guides/contributing/pull-requests.md
Expand Up @@ -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
Expand Down

0 comments on commit db26bdb

Please sign in to comment.