Skip to content

Commit

Permalink
doc: move style guide to findable location
Browse files Browse the repository at this point in the history
Move the style guide to doc/README.md so people might find it. The
current location is easily overlooked, as is evidenced by
#41025
  • Loading branch information
Trott committed Dec 9, 2021
1 parent 18ff583 commit a8cd2dc
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 1 deletion.
File renamed without changes.
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 a8cd2dc

Please sign in to comment.