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 <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Richard Lau <[email protected]>
nodejs · Feb 7, 2019 · f516f68 · f516f68
1 parent 3b74cc6
commit f516f68
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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).