1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add a sentence about REPLACEME in code changes

Browse Source 
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>
This commit is contained in:
Lance Ball 2019-02-06 10:09:23 -05:00 committed by Daniel Bevenius
parent cf43846e25
commit 93a57c3f1f
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/guides/contributing/pull-requests.md
View File

@ -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) Any documentation you write (including code comments and API documentation)
should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included
in the API docs will also be checked when running `make lint` (or 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 For contributing C++ code, you may want to look at the
[C++ Style Guide](../../../CPP_STYLE_GUIDE.md). [C++ Style Guide](../../../CPP_STYLE_GUIDE.md).