From f516f6803288f87c620cc499ed4a5e0ea4705c88 Mon Sep 17 00:00:00 2001 From: Lance Ball Date: Wed, 6 Feb 2019 10:09:23 -0500 Subject: [PATCH] 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 Reviewed-By: Ruben Bridgewater Reviewed-By: James M Snell Reviewed-By: Rich Trott Reviewed-By: Richard Lau --- doc/guides/contributing/pull-requests.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 959d388de1d0c7..0e324211ee9232 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).