diff options
| author | Denys Otrishko <shishugi@gmail.com> | 2020-10-02 12:15:34 +0300 |
|---|---|---|
| committer | Danielle Adams <adamzdanielle@gmail.com> | 2020-10-06 22:10:24 +0300 |
| commit | 91ef862365048970d317b8866c3f4b31a798b42b (patch) | |
| tree | 792cec44caedd8ed997033431dd46eb8513c81f8 /doc | |
| parent | 885840b543d4cf181115931cade730cd37487cc0 (diff) | |
doc: mention adding YAML for APIs in PR contributing guide
PR-URL: https://github.com/nodejs/node/pull/35459
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 5cdf6e82f19..84039f89412 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` +<!-- 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 |