doc: improve release guide

Specify that $VERSION should include the `v` when replacing REPLACEME in documentation. PR-URL: #17677 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>
nodejs · Jan 9, 2018 · ed9f2fe · ed9f2fe
1 parent 79a2833
commit ed9f2fe
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/releases.md b/doc/releases.md
@@ -157,6 +157,8 @@ were first added in this version. The relevant commits should already include
 `sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or
 `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md`.
 
+*Note*: `$VERSION` should be prefixed with a `v`
+
 If this release includes any new deprecations it is necessary to ensure that
 those are assigned a proper static deprecation code. These are listed in the
 docs (see `doc/api/deprecations.md`) and in the source as `DEP00XX`. The code