doc: mention adding YAML for APIs in PR contributing guide

PR-URL: #35459 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Mary Marchini <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Oct 6, 2020 · 91ef862 · 91ef862
1 parent 885840b
commit 91ef862
Showing 1 changed file with 11 additions and 1 deletion.
diff --git 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`
+<!-- YAML
+added: REPLACEME
+-->
+
+* {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