diff options
| author | Lance Ball <lball@redhat.com> | 2019-02-06 10:09:23 -0500 |
|---|---|---|
| committer | Daniel Bevenius <daniel.bevenius@gmail.com> | 2019-02-07 05:26:04 +0100 |
| commit | 93a57c3f1fe229f3d70357f5146293dc6b5dc3a1 (patch) | |
| tree | 1533f55dbb677071d26fd4a6d84b15dbbc9e91b7 /doc | |
| parent | cf43846e25c67c9f36152d0643faf181df247527 (diff) | |
| download | android-node-v8-93a57c3f1fe229f3d70357f5146293dc6b5dc3a1.tar.gz android-node-v8-93a57c3f1fe229f3d70357f5146293dc6b5dc3a1.tar.bz2 android-node-v8-93a57c3f1fe229f3d70357f5146293dc6b5dc3a1.zip | |
doc: add a sentence about REPLACEME in code changes
When adding to the REPL API recently, I was unsure what to put as a
version number for the new method I added. This change adds a reference
to `releases.md` where the use of `REPLACEME` is discussed.
PR-URL: https://github.com/nodejs/node/pull/25961
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 959d388de1..0e324211ee 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -116,7 +116,8 @@ time to ensure that the changes follow the Node.js code style guide. Any documentation you write (including code comments and API documentation) should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included in the API docs will also be checked when running `make lint` (or -`vcbuild.bat lint` on Windows). +`vcbuild.bat lint` on Windows). If you are adding to or deprecating an API, +use `REPLACEME` for the version number in the documentation YAML. For contributing C++ code, you may want to look at the [C++ Style Guide](../../../CPP_STYLE_GUIDE.md). |