Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add a sentence about REPLACEME in code changes #25961

Closed
wants to merge 2 commits into from
Closed

doc: add a sentence about REPLACEME in code changes #25961

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a19cd87
doc: add a sentence about REPLACEME in code changes
lance Feb 6, 2019
8b06da9
squash: incorporate feedback from contributors
lance Feb 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/guides/contributing/pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,9 @@ 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 the API,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`vcbuild.bat lint` on Windows). If you are adding to or deprecating the API,
`vcbuild.bat lint` on Windows). If you are adding to or deprecating an API,

be sure to use `REPLACEME` for the version numbers as specified in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
be sure to use `REPLACEME` for the version numbers as specified in
use `REPLACEME` for the version number as specified in

[releases.md](../../releases.md#step-3-update-any-replaceme-and-dep00xx-tags-in-the-docs).

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