Skip to content

Commit f516f68

Browse files
lanceaddaleax
authored andcommitted
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: #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>
1 parent 3b74cc6 commit f516f68

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/guides/contributing/pull-requests.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,8 @@ time to ensure that the changes follow the Node.js code style guide.
116116
Any documentation you write (including code comments and API documentation)
117117
should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included
118118
in the API docs will also be checked when running `make lint` (or
119-
`vcbuild.bat lint` on Windows).
119+
`vcbuild.bat lint` on Windows). If you are adding to or deprecating an API,
120+
use `REPLACEME` for the version number in the documentation YAML.
120121

121122
For contributing C++ code, you may want to look at the
122123
[C++ Style Guide](../../../CPP_STYLE_GUIDE.md).

0 commit comments

Comments
 (0)