@@ -72,17 +72,17 @@ Fork the project [on GitHub](https://github.com/nodejs/node) and clone your fork
72
72
locally.
73
73
74
74
``` text
75
- $ git clone [email protected] :username/node.git
76
- $ cd node
77
- $ git remote add upstream https://github.com/nodejs/node.git
78
- $ git fetch upstream
75
+ git clone [email protected] :username/node.git
76
+ cd node
77
+ git remote add upstream https://github.com/nodejs/node.git
78
+ git fetch upstream
79
79
```
80
80
81
81
Configure ` git ` so that it knows who you are:
82
82
83
83
``` text
84
- $ git config user.name "J. Random User"
85
- $ git config user.email "[email protected] "
84
+ git config user.name "J. Random User"
85
+ git config user.email "[email protected] "
86
86
```
87
87
88
88
You can use any name/email address you prefer here. We only use the
@@ -98,10 +98,10 @@ make sure this local email is also added to your
98
98
99
99
As a best practice to keep your development environment as organized as
100
100
possible, create local branches to work within. These should also be created
101
- directly off of the ` master ` branch.
101
+ directly off of the upstream default branch.
102
102
103
103
``` text
104
- $ git checkout -b my-branch -t upstream/master
104
+ git checkout -b my-branch -t upstream/HEAD
105
105
```
106
106
107
107
## The process of making changes
@@ -149,8 +149,8 @@ commits any single pull request may have, and many contributors find it easier
149
149
to review changes that are split across multiple commits.
150
150
151
151
``` text
152
- $ git add my/changed/files
153
- $ git commit
152
+ git add my/changed/files
153
+ git commit
154
154
```
155
155
156
156
Multiple commits often get squashed when they are landed. See the
@@ -219,12 +219,11 @@ to use `git rebase` (not `git merge`) to synchronize your work with the main
219
219
repository.
220
220
221
221
``` text
222
- $ git fetch upstream
223
- $ git rebase upstream/master
222
+ git fetch upstream HEAD
223
+ git rebase FETCH_HEAD
224
224
```
225
225
226
- This ensures that your working branch has the latest changes from ` nodejs/node `
227
- master.
226
+ This ensures that your working branch has the latest changes from ` nodejs/node ` .
228
227
229
228
### Step 6: Test
230
229
@@ -242,7 +241,7 @@ Before submitting your changes in a pull request, always run the full Node.js
242
241
test suite. To run the tests (including code linting) on Unix / macOS:
243
242
244
243
``` text
245
- $ ./configure && make -j4 test
244
+ ./configure && make -j4 test
246
245
```
247
246
248
247
And on Windows:
@@ -262,7 +261,7 @@ begin the process of opening a pull request by pushing your working branch to
262
261
your fork on GitHub.
263
262
264
263
``` text
265
- $ git push origin my-branch
264
+ git push origin my-branch
266
265
```
267
266
268
267
### Step 8: Opening the pull request
@@ -291,18 +290,18 @@ branch, add a new commit with those changes, and push those to your fork.
291
290
GitHub will automatically update the pull request.
292
291
293
292
``` text
294
- $ git add my/changed/files
295
- $ git commit
296
- $ git push origin my-branch
293
+ git add my/changed/files
294
+ git commit
295
+ git push origin my-branch
297
296
```
298
297
299
- It is also frequently necessary to synchronize your pull request with other
300
- changes that have landed in ` master ` by using ` git rebase ` :
298
+ If a git conflict arises, it is necessary to synchronize your branch with other
299
+ changes that have landed upstream by using ` git rebase ` :
301
300
302
301
``` text
303
- $ git fetch --all
304
- $ git rebase upstream/master
305
- $ git push --force-with-lease origin my-branch
302
+ git fetch upstream HEAD
303
+ git rebase FETCH_HEAD
304
+ git push --force-with-lease origin my-branch
306
305
```
307
306
308
307
** Important:** The ` git push --force-with-lease ` command is one of the few ways
@@ -349,10 +348,10 @@ your pull request waiting longer than you expect, see the
349
348
350
349
When a collaborator lands your pull request, they will post
351
350
a comment to the pull request page mentioning the commit(s) it
352
- landed as. GitHub often shows the pull request as ` Closed ` at this
351
+ landed as. GitHub might show the pull request as ` Closed ` at this
353
352
point, but don't worry. If you look at the branch you raised your
354
- pull request against (probably ` master ` ) , you should see a commit with
355
- your name on it. Congratulations and thanks for your contribution!
353
+ pull request against, you should see a commit with your name on it.
354
+ Congratulations and thanks for your contribution!
356
355
357
356
## Reviewing pull requests
358
357
@@ -535,7 +534,7 @@ For the size of "one logical change",
535
534
[ 0b5191f] ( https://github.com/nodejs/node/commit/0b5191f15d0f311c804d542b67e2e922d98834f8 )
536
535
can be a good example. It touches the implementation, the documentation,
537
536
and the tests, but is still one logical change. All tests should always pass
538
- when each individual commit lands on the master branch .
537
+ when each individual commit lands on one of the ` nodejs/node ` branches .
539
538
540
539
### Getting approvals for your pull request
541
540
0 commit comments