diff options
| author | Alexey Orlenko <eaglexrlnk@gmail.com> | 2017-05-20 16:15:58 -0400 |
|---|---|---|
| committer | Refael Ackermann <refack@gmail.com> | 2017-05-25 18:49:41 -0400 |
| commit | 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d (patch) | |
| tree | d0ba4f62fff9db7d42b3f86c7358d9219b288698 /doc/releases.md | |
| parent | b3d1e3d4c720729c8f14e413a285660547ee677a (diff) | |
| download | android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.gz android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.bz2 android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.zip | |
doc: make the style of notes consistent
Make the style of "Note:" paragraphs consistent and document the
guidelines in `doc/STYLE_GUIDE.md`.
PR-URL: https://github.com/nodejs/node/pull/13133
Fixes: https://github.com/nodejs/node/issues/13131
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/releases.md')
| -rw-r--r-- | doc/releases.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/releases.md b/doc/releases.md index 6433eeeacb..eafc906026 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -86,7 +86,7 @@ This macro is used to signal an ABI version for native addons. It currently has The general rule is to bump this version when there are _breaking ABI_ changes and also if there are non-trivial API changes. The rules are not yet strictly defined, so if in doubt, please confer with someone that will have a more informed perspective, such as a member of the NAN team. -**Note** that it is current TSC policy to bump major version when ABI changes. If you see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC. Commits may need to be reverted or a major version bump may need to happen. +*Note*: It is current TSC policy to bump major version when ABI changes. If you see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC. Commits may need to be reverted or a major version bump may need to happen. ### 3. Update the Changelog @@ -279,7 +279,8 @@ Use `tools/release.sh` to promote and sign the build. When run, it will perform If you didn't wait for ARM builds in the previous step before promoting the release, you should re-run `tools/release.sh` after the ARM builds have finished. That will move the ARM artifacts into the correct location. You will be prompted to re-sign SHASUMS256.txt. -Note: it is possible to only sign a release by running `./tools/release.sh -s vX.Y.Z`. +*Note*: It is possible to only sign a release by running +`./tools/release.sh -s vX.Y.Z`. ### 13. Check the Release |