From 91ef862365048970d317b8866c3f4b31a798b42b Mon Sep 17 00:00:00 2001 From: Denys Otrishko Date: Fri, 2 Oct 2020 12:15:34 +0300 Subject: [PATCH] doc: mention adding YAML for APIs in PR contributing guide PR-URL: https://github.com/nodejs/node/pull/35459 Reviewed-By: Matteo Collina Reviewed-By: Richard Lau Reviewed-By: Rich Trott Reviewed-By: Gireesh Punathil Reviewed-By: Mary Marchini Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat --- doc/guides/contributing/pull-requests.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 5cdf6e82f19ec4..84039f89412b71 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -130,7 +130,17 @@ Any documentation you write (including code comments and API documentation) should follow the [Style Guide](../doc-style-guide.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, -use `REPLACEME` for the version number in the documentation YAML. +add or change the appropriate YAML documentation. Use `REPLACEME` for the +version number in the documentation YAML: + +```markdown +### `request.method` + + +* {string} The request method. +``` For contributing C++ code, you may want to look at the [C++ Style Guide](../cpp-style-guide.md), as well as the