GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc: enhance guides by fixing and making grammar more consistent · nodejs/node@182aaf5

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/guides

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/guides/collaborator-guide.md‎`

Copy file name to clipboardExpand all lines: doc/guides/collaborator-guide.md

+30-28Lines changed: 30 additions & 28 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -109,8 +109,8 @@ review by @-mention.`
`109`	`109`	`See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).`
`110`	`110`
`111`	`111`	`If you are the first Collaborator to approve a pull request that has no CI yet,`
`112`		`-please [start one](#testing-and-ci). Please also start a new CI if the PR`
`113`		`-creator pushed new code since the last CI run.`
	`112`	`+please [start one](#testing-and-ci). Please also start a new CI if the`
	`113`	`+pull request creator pushed new code since the last CI run.`
`114`	`114`
`115`	`115`	`### Consensus Seeking`
`116`	`116`
`@@ -269,22 +269,22 @@ master branch.`
`269`	`269`
`270`	`270`	`Examples of breaking changes include:`
`271`	`271`
`272`		`-* removal or redefinition of existing API arguments`
`273`		`-* changing return values`
`274`		`-* removing or modifying existing properties on an options argument`
`275`		`-* adding or removing errors`
`276`		`-* altering expected timing of an event`
`277`		`-* changing the side effects of using a particular API`
	`272`	`+* Removal or redefinition of existing API arguments.`
	`273`	`+* Changing return values.`
	`274`	`+* Removing or modifying existing properties on an options argument.`
	`275`	`+* Adding or removing errors.`
	`276`	`+* Altering expected timing of an event.`
	`277`	`+* Changing the side effects of using a particular API.`
`278`	`278`
`279`	`279`	`#### Breaking Changes and Deprecations`
`280`	`280`
`281`	`281`	`Existing stable public APIs that change in a backward-incompatible way must`
`282`	`282`	`undergo deprecation. The exceptions to this rule are:`
`283`	`283`
`284`		`-* Adding or removing errors thrown or reported by a public API;`
`285`		`-* Changing error messages for errors without error code;`
`286`		`-* Altering the timing and non-internal side effects of the public API;`
`287`		`-* Changes to errors thrown by dependencies of Node.js, such as V8;`
	`284`	`+* Adding or removing errors thrown or reported by a public API.`
	`285`	`+* Changing error messages for errors without error code.`
	`286`	`+* Altering the timing and non-internal side effects of the public API.`
	`287`	`+* Changes to errors thrown by dependencies of Node.js, such as V8.`
`288`	`288`	`* One-time exceptions granted by the TSC.`
`289`	`289`
`290`	`290`	`For more information, see [Deprecations](#deprecations).`
`@@ -310,7 +310,7 @@ after-the-fact.`
`310`	`310`	Revert commits with `git revert <HASH>` or `git revert <FROM>..<TO>`. The
`311`	`311`	`generated commit message will not have a subsystem and may violate line length`
`312`	`312`	rules. That is OK. Append the reason for the revert and any `Refs` or `Fixes`
`313`		`-metadata. Raise a Pull Request like any other change.`
	`313`	`+metadata. Raise a pull request like any other change.`
`314`	`314`
`315`	`315`	`### Introducing New Modules`
`316`	`316`
`@@ -400,10 +400,10 @@ deprecation level of an API.`
`400`	`400`	`Collaborators may opt to elevate pull requests or issues to the [TSC][].`
`401`	`401`	`Do this if a pull request or issue:`
`402`	`402`
`403`		-* is labeled `semver-major`, or
`404`		`-* has a significant impact on the codebase, or`
`405`		`-* is controversial, or`
`406`		`-* is at an impasse among Collaborators who are participating in the discussion.`
	`403`	+* Is labeled `semver-major`, or
	`404`	`+* Has a significant impact on the codebase, or`
	`405`	`+* Is controversial, or`
	`406`	`+* Is at an impasse among Collaborators who are participating in the discussion.`
`407`	`407`
`408`	`408`	@-mention the `@nodejs/tsc` GitHub team if you want to elevate an issue to the
`409`	`409`	`[TSC][]. Do not use the GitHub UI on the right-hand side to assign to`
`@@ -573,7 +573,7 @@ for that commit. This is an opportunity to fix commit messages.`
`573`	`573`	`* The commit message text must conform to the [commit message guidelines][].`
`574`	`574`	`* <a name="metadata"></a>Change the original commit message to include metadata. (The`
`575`	`575`	[`git node metadata`][git-node-metadata] command can generate the metadata
`576`		`- for you.)`
	`576`	`+ for you).`
`577`	`577`
`578`	`578`	* Required: A `PR-URL:` line that references the full GitHub URL of the pull
`579`	`579`	`request. This makes it easy to trace a commit back to the conversation that`
`@@ -584,7 +584,8 @@ for that commit. This is an opportunity to fix commit messages.`
`584`	`584`	`background.`
`585`	`585`	* Required: A `Reviewed-By: Name <email>` line for each Collaborator who
`586`	`586`	`reviewed the change.`
`587`		`- * Useful for @mentions / contact list if something goes wrong in the PR.`
	`587`	`+ * Useful for @mentions / contact list if something goes wrong in the`
	`588`	`+ pull request.`
`588`	`589`	`* Protects against the assumption that GitHub will be around forever.`
`589`	`590`
`590`	`591`	`Other changes may have landed on master since the successful CI run. As a`
`@@ -599,12 +600,13 @@ $ git rev-list upstream/master...HEAD \| xargs core-validate-commit`
`599`	`600`
`600`	`601`	`Optional: For your own commits, force push the amended commit to the pull`
`601`	`602`	request branch. If your branch name is `bugfix`, then: `git push
`602`		---force-with-lease origin master:bugfix`. Don't close the PR. It will close
`603`		`-after you push it upstream. It will have the purple merged status rather than`
`604`		`-the red closed status. If you close the PR before GitHub adjusts its status, it`
`605`		`-will show up as a 0 commit PR with no changed files. The order of operations is`
`606`		`-important. If you push upstream before you push to your branch, GitHub will`
`607`		`-close the issue with the red closed status.`
	`603`	+--force-with-lease origin master:bugfix`. Don't close the pull request.
	`604`	`+It will close after you push it upstream. It will have the purple merged`
	`605`	`+status rather than the red closed status. If you close the pull request`
	`606`	`+before GitHub adjusts its status, it will show up as a 0 commit pull`
	`607`	`+request with no changed files. The order of operations is important.`
	`608`	`+If you push upstream before you push to your branch, GitHub will close`
	`609`	`+the issue with the red closed status.`
`608`	`610`
`609`	`611`	`Time to push it:`
`610`	`612`
`@@ -645,7 +647,7 @@ git push upstream master`
`645`	`647`	`### I Made a Mistake`
`646`	`648`
`647`	`649`	`* Ping a TSC member.`
`648`		-* `#node-dev` on freenode
	`650`	+* `#node-dev` on freenode.
`649`	`651`	* With `git`, there's a way to override remote trees by force pushing
`650`	`652`	(`git push -f`). This is generally forbidden as it creates conflicts in other
`651`	`653`	`people's forks. It is permissible for simpler slip-ups such as typos in commit`
@@ -701,8 +703,8 @@ land on the staging branches, the backporter removes the `lts-watch-` label.
`701`	`703`	Likewise, as commits land in an LTS release, the releaser removes the `land-on-`
`702`	`704`	`label.`
`703`	`705`
`704`		-Attach the appropriate `lts-watch-` label to any PR that may impact an LTS
`705`		`-release.`
	`706`	+Attach the appropriate `lts-watch-` label to any pull request that
	`707`	`+may impact an LTS release.`
`706`	`708`
`707`	`709`	`## Who to CC in the issue tracker`
`708`	`710`

Collapse file

`‎doc/guides/cpp-style-guide.md‎`

Copy file name to clipboardExpand all lines: doc/guides/cpp-style-guide.md

+14-14Lines changed: 14 additions & 14 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -40,13 +40,13 @@ runtime features.`
`40`	`40`
`41`	`41`	`Coding guidelines are based on the following guides (highest priority first):`
`42`	`42`
`43`		`-1. This document`
`44`		`-2. The [Google C++ Style Guide][]`
`45`		`-3. The ISO [C++ Core Guidelines][]`
	`43`	`+1. This document.`
	`44`	`+2. The [Google C++ Style Guide][].`
	`45`	`+3. The ISO [C++ Core Guidelines][].`
`46`	`46`
`47`		`-In general code should follow the C++ Core Guidelines, unless overridden by the`
	`47`	`+In general, code should follow the C++ Core Guidelines, unless overridden by the`
`48`	`48`	`Google C++ Style Guide or this document. At the moment these guidelines are`
`49`		`-checked manually by reviewers, with the goal to validate this with automatic`
	`49`	`+checked manually by reviewers with the goal to validate this with automatic`
`50`	`50`	`tools.`
`51`	`51`
`52`	`52`	`## Formatting`
`@@ -282,11 +282,11 @@ data[0] = 12345;`
`282`	`282`
`283`	`283`	`### Type casting`
`284`	`284`
`285`		-* Use `static_cast<T>` if casting is required, and it is valid
`286`		-* Use `reinterpret_cast` only when it is necessary
`287`		-* Avoid C-style casts (`(type)value`)
	`285`	+* Use `static_cast<T>` if casting is required, and it is valid.
	`286`	+* Use `reinterpret_cast` only when it is necessary.
	`287`	+* Avoid C-style casts (`(type)value`).
`288`	`288`	* `dynamic_cast` does not work because Node.js is built without
`289`		`- [Run Time Type Information][]`
	`289`	`+ [Run Time Type Information][].`
`290`	`290`
`291`	`291`	`Further reading:`
`292`	`292`
`@@ -313,13 +313,13 @@ for (const auto& item : some_map) {`
`313`	`313`
`314`	`314`	### Do not include `.h` if `-inl.h` has already been included
`315`	`315`
`316`		`-Do`
	`316`	`+Do:`
`317`	`317`
`318`	`318`	```cpp
`319`	`319`	`#include "util-inl.h" // already includes util.h`
`320`	`320`	```
`321`	`321`
`322`		`-instead of`
	`322`	`+Instead of:`
`323`	`323`
`324`	`324`	```cpp
`325`	`325`	`#include "util.h"`
`@@ -383,9 +383,9 @@ exports.foo = function(str) {`
`383`	`383`	`#### Avoid throwing JavaScript errors in nested C++ methods`
`384`	`384`
`385`	`385`	`When you need to throw a JavaScript exception from C++ (i.e.`
`386`		-`isolate()->ThrowException()`) prefer to do it as close to the return to JS as
`387`		`-possible, and not inside of nested C++ calls. Since this changes the JS`
`388`		`-execution state doing it closest to where it is consumed reduces the chances of`
	`386`	+`isolate()->ThrowException()`), do it as close to the return to JavaScript as
	`387`	`+possible, and not inside of nested C++ calls. Since this changes the JavaScript`
	`388`	`+execution state, doing it closest to where it is consumed reduces the chances of`
`389`	`389`	`side effects.`
`390`	`390`
`391`	`391`	Node.js is built [without C++ exception handling][], so code using `throw` or

Collapse file

`‎doc/guides/cve-management-process.md‎`

Copy file name to clipboardExpand all lines: doc/guides/cve-management-process.md

+2-2Lines changed: 2 additions & 2 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ than two remaining CVEs a new block must be requested as follows:`
`63`	`63`	`to the Available list.`
`64`	`64`
`65`	`65`	`All changes to the files for managing CVEs in a given year will`
`66`		`-be done through Pull Requests so that we have a record of how`
	`66`	`+be done through pull requests so that we have a record of how`
`67`	`67`	`the CVEs have been assigned.`
`68`	`68`
`69`	`69`	`CVEs are only valid for a specific year. At the beginning of each`
`@@ -122,7 +122,7 @@ following steps are used to assign, announce and report a CVE.`
`122`	`122`	`verification of the identity of the CVE submitter.`
`123`	`123`
`124`	`124`	`For each CVE listed, the additional data must include the following fields`
`125`		`- updated with appropriate data for the CVE`
	`125`	`+ updated with appropriate data for the CVE:`
`126`	`126`	```text
`127`	`127`	`[CVEID]: CVE-XXXX-XXXX`
`128`	`128`	`[PRODUCT]: Node.js`

Collapse file

`‎doc/guides/maintaining-openssl.md‎`

Copy file name to clipboardExpand all lines: doc/guides/maintaining-openssl.md

+13-11Lines changed: 13 additions & 11 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`	This document describes how to update `deps/openssl/`.
`4`	`4`
`5`	`5`	`## Requirements`
`6`		`-* Linux environment`
	`6`	`+* Linux environment.`
`7`	`7`	* `perl` Only Perl version 5 is tested.
`8`		-* `nasm` (<http://www.nasm.us/>) The version of 2.11 or higher is needed.
`9`		-* GNU `as` in binutils. The version of 2.26 or higher is needed.
	`8`	+* `nasm` (<http://www.nasm.us/>) Version 2.11 or higher is needed.
	`9`	+* GNU `as` in binutils. Version 2.26 or higher is needed.
`10`	`10`
`11`	`11`	`## 0. Check Requirements`
`12`	`12`
`@@ -39,7 +39,8 @@ them.`
`39`	`39`	`% git commit openssl`
`40`	`40`	````
`41`	`41`
`42`		`-The commit message can be (with the openssl version set to the relevant value):`
	`42`	`+The commit message can be written as (with the openssl version set`
	`43`	`+to the relevant value):`
`43`	`44`	```text
`44`	`45`	`deps: upgrade openssl sources to 1.1.0h`
`45`	`46`
@@ -62,15 +63,15 @@ Use `make` to regenerate all platform dependent files in
`62`	`63`
`63`	`64`	`## 3. Check diffs`
`64`	`65`
`65`		`-Check diffs if updates are right. Even if no updates in openssl`
`66`		-sources, `buildinf.h` files will be updated for they have a timestamp
	`66`	`+Check diffs to ensure updates are right. Even if there are no updates in openssl`
	`67`	+sources, `buildinf.h` files will be updated because they have timestamp
`67`	`68`	`data in them.`
`68`	`69`	```sh
`69`	`70`	`% git diff -- deps/openssl`
`70`	`71`	```
`71`	`72`
`72`		-Note: On Windows, OpenSSL Configure generates `makefile` that can be
`73`		-used for `nmake` command. The `make` command in the step 2 above uses
	`73`	+Note: On Windows, OpenSSL Configure generates a `makefile` that can be
	`74`	+used for the `nmake` command. The `make` command in step 2 (above) uses
`74`	`75`	`Makefile_VC-WIN64A` and `Makefile_VC-WIN32` that are manually
`75`	`76`	`created. When source files or build options are updated in Windows,`
`76`	`77`	`it needs to change these two Makefiles by hand. If you are not sure,`
`@@ -79,7 +80,7 @@ please ask @shigeki for details.`
`79`	`80`	`## 4. Commit and make test`
`80`	`81`
`81`	`82`	`Update all architecture dependent files. Do not forget to git add or remove`
`82`		`-files if they are changed before commit:`
	`83`	`+files if they are changed before committing:`
`83`	`84`	```sh
`84`	`85`	`% git add deps/openssl/config/archs`
`85`	`86`	`% git add deps/openssl/openssl/include/crypto/bn_conf.h`
`@@ -88,7 +89,8 @@ files if they are changed before commit:`
`88`	`89`	`% git commit`
`89`	`90`	```
`90`	`91`
`91`		`-The commit message can be (with the openssl version set to the relevant value):`
	`92`	`+The commit message can be written as (with the openssl version set`
	`93`	`+to the relevant value):`
`92`	`94`	```text
`93`	`95`	`deps: update archs files for OpenSSL-1.1.0`
`94`	`96`
`@@ -102,4 +104,4 @@ The commit message can be (with the openssl version set to the relevant value):`
`102`	`104`	`$ git commit`
`103`	`105`	```
`104`	`106`
`105`		`-Finally, build Node.js and run tests.`
	`107`	`+Finally, build Node.js and run the tests.`

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.