| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent c26258e commit faa55fb
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -16,7 +16,7 @@ For general help using Node.js, please file an issue at the | |||
| 16 | 16 | [Node.js help repository](https://github.com/nodejs/help/issues). | |
| 17 | 17 | ||
| 18 | 18 | Discussion of non-technical topics including subjects like intellectual | |
| 19 | - property, trademark and high level project questions should move to the | ||
| 19 | + property, trademark, and high level project questions should move to the | ||
| 20 | 20 | [Technical Steering Committee (TSC)](https://github.com/nodejs/TSC/issues) | |
| 21 | 21 | instead. | |
| 22 | 22 | ||
@@ -112,8 +112,8 @@ changed and why. Follow these guidelines when writing one: | |||
| 112 | 112 | lowercase with the exception of proper nouns, acronyms, and the ones that | |
| 113 | 113 | refer to code, like function/variable names. The description should | |
| 114 | 114 | be prefixed with the name of the changed subsystem and start with an | |
| 115 | - imperative verb, for example, "net: add localAddress and localPort | ||
| 116 | - to Socket". | ||
| 115 | + imperative verb. Example: "net: add localAddress and localPort | ||
| 116 | + to Socket" | ||
| 117 | 117 | 2. Keep the second line blank. | |
| 118 | 118 | 3. Wrap all other lines at 72 columns. | |
| 119 | 119 | ||
@@ -124,11 +124,11 @@ subsystem: explain the commit in one line | |||
| 124 | 124 | ||
| 125 | 125 | Body of commit message is a few lines of text, explaining things | |
| 126 | 126 | in more detail, possibly giving some background about the issue | |
| 127 | - being fixed, etc. etc. | ||
| 127 | + being fixed, etc. | ||
| 128 | 128 | ||
| 129 | 129 | The body of the commit message can be several paragraphs, and | |
| 130 | 130 | please do proper word-wrap and keep columns shorter than about | |
| 131 | - 72 characters or so. That way `git log` will show things | ||
| 131 | + 72 characters or so. That way, `git log` will show things | ||
| 132 | 132 | nicely even when it is indented. | |
| 133 | 133 | ``` | |
| 134 | 134 | ||
@@ -173,19 +173,19 @@ $ ./configure && make -j4 test | |||
| 173 | 173 | Windows: | |
| 174 | 174 | ||
| 175 | 175 | ```text | |
| 176 | - .\vcbuild nosign test | ||
| 176 | + > vcbuild test | ||
| 177 | 177 | ``` | |
| 178 | 178 | ||
| 179 | 179 | (See the [BUILDING.md](./BUILDING.md) for more details.) | |
| 180 | 180 | ||
| 181 | - Make sure the linter is happy and that all tests pass. Please, do not submit | ||
| 182 | - patches that fail either check. | ||
| 181 | + Make sure the linter does not report any issues and that all tests pass. Please | ||
| 182 | + do not submit patches that fail either check. | ||
| 183 | 183 | ||
| 184 | - Running `make test`/`.\vcbuild nosign test` will run the linter as well unless one or | ||
| 184 | + Running `make test`/`vcbuild test` will run the linter as well unless one or | ||
| 185 | 185 | more tests fail. | |
| 186 | 186 | ||
| 187 | 187 | If you want to run the linter without running tests, use | |
| 188 | - `make lint`/`.\vcbuild nosign jslint`. | ||
| 188 | + `make lint`/`vcbuild lint`. | ||
| 189 | 189 | ||
| 190 | 190 | If you are updating tests and just want to run a single test to check it, you | |
| 191 | 191 | can use this syntax to run it exactly as the test harness would: | |
@@ -217,7 +217,7 @@ Pull requests are usually reviewed within a few days. | |||
| 217 | 217 | ### Step 7: Discuss and update | |
| 218 | 218 | ||
| 219 | 219 | You will probably get feedback or requests for changes to your Pull Request. | |
| 220 | - This is a big part of the submission process, so don't be disheartened! | ||
| 220 | + This is a big part of the submission process so don't be disheartened! | ||
| 221 | 221 | ||
| 222 | 222 | To make changes to an existing Pull Request, make the changes to your branch. | |
| 223 | 223 | When you push that branch to your fork, GitHub will automatically update the | |
@@ -255,15 +255,15 @@ If in doubt, you can always ask for guidance in the Pull Request or on | |||
| 255 | 255 | ||
| 256 | 256 | Feel free to post a comment in the Pull Request to ping reviewers if you are | |
| 257 | 257 | awaiting an answer on something. If you encounter words or acronyms that | |
| 258 | - seem unfamiliar, check out this | ||
| 258 | + seem unfamiliar, refer to this | ||
| 259 | 259 | [glossary](https://sites.google.com/a/chromium.org/dev/glossary). | |
| 260 | 260 | ||
| 261 | 261 | Note that multiple commits often get squashed when they are landed (see the | |
| 262 | 262 | notes about [commit squashing](#commit-squashing)). | |
| 263 | 263 | ||
| 264 | 264 | ### Step 8: Landing | |
| 265 | 265 | ||
| 266 | - In order to get landed, a Pull Request needs to be reviewed and | ||
| 266 | + In order to land, a Pull Request needs to be reviewed and | ||
| 267 | 267 | [approved](#getting-approvals-for-your-pull-request) by | |
| 268 | 268 | at least one Node.js Collaborator and pass a | |
| 269 | 269 | [CI (Continuous Integration) test run](#ci-testing). | |
@@ -283,8 +283,8 @@ your name on it. Congratulations and thanks for your contribution! | |||
| 283 | 283 | ||
| 284 | 284 | ### Commit Squashing | |
| 285 | 285 | ||
| 286 | - When the commits in your Pull Request get landed, they will be squashed | ||
| 287 | - into one commit per logical change, with metadata added to the commit | ||
| 286 | + When the commits in your Pull Request land, they will be squashed | ||
| 287 | + into one commit per logical change. Metadata will be added to the commit | ||
| 288 | 288 | message (including links to the Pull Request, links to relevant issues, | |
| 289 | 289 | and the names of the reviewers). The commit history of your Pull Request, | |
| 290 | 290 | however, will stay intact on the Pull Request page. | |
@@ -314,9 +314,9 @@ Every Pull Request needs to be tested | |||
| 314 | 314 | to make sure that it works on the platforms that Node.js | |
| 315 | 315 | supports. This is done by running the code through the CI system. | |
| 316 | 316 | ||
| 317 | - Only a Collaborator can request a CI run. Usually one of them will do it | ||
| 317 | + Only a Collaborator can start a CI run. Usually one of them will do it | ||
| 318 | 318 | for you as approvals for the Pull Request come in. | |
| 319 | - If not, you can ask a Collaborator to request a CI run. | ||
| 319 | + If not, you can ask a Collaborator to start a CI run. | ||
| 320 | 320 | ||
| 321 | 321 | ### Waiting Until the Pull Request Gets Landed | |
| 322 | 322 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments