@@ -56,7 +56,7 @@ When you are ready to make some changes to the code, you should start a new
56
56
branch. Branches that are for a collection of related edits are often called
57
57
'feature branches'.
58
58
59
- Making an new branch for each set of related changes will make it easier for
59
+ Making a new branch for each set of related changes will make it easier for
60
60
someone reviewing your branch to see what you are doing.
61
61
62
62
Choose an informative name for the branch to remind yourself and the rest of us
@@ -147,8 +147,8 @@ Open a pull request
147
147
When you are ready to ask for someone to review your code and consider a merge,
148
148
`submit your Pull Request (PR) <https://docs.github.com/pull-requests >`_.
149
149
150
- Enter a title for the set of changes, and some explanation of what you've done.
151
- Say if there is anything you'd like particular attention for - like a
150
+ Enter a title for the set of changes with some explanation of what you've done.
151
+ Mention anything you'd like particular attention for - such as a
152
152
complicated change or some code you are not happy with.
153
153
154
154
If you don't think your request is ready to be merged, just say so in your pull
@@ -210,8 +210,8 @@ Rewriting commit history
210
210
211
211
Do this only for your own feature branches.
212
212
213
- There's an embarrassing typo in a commit you made? Or perhaps the you
214
- made several false starts you would like the posterity not to see.
213
+ Is there an embarrassing typo in a commit you made? Or perhaps you
214
+ made several false starts you don't want posterity to see.
215
215
216
216
This can be done via *interactive rebasing *.
217
217
@@ -279,7 +279,7 @@ message. After revising it, we get the output::
279
279
1 files changed, 79 insertions(+), 61 deletions(-)
280
280
Successfully rebased and updated refs/heads/my-feature-branch.
281
281
282
- and the history looks now like this::
282
+ and now, the history looks like this::
283
283
284
284
0f22701 Fix a few bugs + disable
285
285
721fc64 ENH: Sophisticated feature
@@ -313,8 +313,8 @@ while. In the meantime, ``main`` has progressed from commit E to commit (say) G:
313
313
314
314
At this stage you consider merging ``main `` into your feature branch, and you
315
315
remember that this page sternly advises you not to do that, because the
316
- history will get messy. Most of the time you can just ask for a review, and not
317
- worry that ``main `` has got a little ahead. But sometimes, the changes in
316
+ history will get messy. Most of the time, you can just ask for a review without
317
+ worrying about whether ``main `` has got a little ahead; however sometimes, the changes in
318
318
``main `` might affect your changes, and you need to harmonize them. In this
319
319
situation you may prefer to do a rebase.
320
320
@@ -349,7 +349,7 @@ command can be written more succinctly as::
349
349
350
350
git rebase upstream/main
351
351
352
- When all looks good you can delete your backup branch::
352
+ When all looks good, you can delete your backup branch::
353
353
354
354
git branch -D tmp
355
355
@@ -389,8 +389,8 @@ a git history that looks something like
389
389
390
390
where you have pushed the commits ``A,B,C `` to your fork on GitHub (under the
391
391
remote name *origin *) but now have the commits ``A' `` and ``E `` on your local
392
- branch *cool-feature *. If you try to push the new commits to GitHub it will
393
- fail with an error that looks like ::
392
+ branch *cool-feature *. If you try to push the new commits to GitHub, it will
393
+ fail and show an error that looks like ::
394
394
395
395
$ git push
396
396
Pushing to github.com:origin/matplotlib.git
@@ -402,8 +402,8 @@ fail with an error that looks like ::
402
402
hint: 'git pull ...') before pushing again.
403
403
hint: See the 'Note about fast-forwards' in 'git push --help' for details.
404
404
405
- If this push had succeed then the commits ``A ``, ``B ``, and ``C `` would no
406
- longer be referenced by any branch and be discarded:
405
+ If this push had succeeded, the commits ``A ``, ``B ``, and ``C `` would no
406
+ longer be referenced by any branch and they would be discarded:
407
407
408
408
.. code-block :: none
409
409
@@ -415,7 +415,7 @@ GitHub also adds the helpful suggestion to pull the remote changes and then try
415
415
pushing again. In some cases, such as if you and a colleague are both
416
416
committing and pushing to the same branch, this is a correct course of action.
417
417
418
- However, in the case of having intentionally re-written history we *want * to
418
+ However, in the case of having intentionally re-written history, we *want * to
419
419
discard the commits on the remote and replace them with the new-and-improved
420
420
versions from our local branch. In this case, what we want to do is ::
421
421
@@ -428,5 +428,5 @@ will only do the push if the remote branch is where the local ``git`` client
428
428
thought it was.
429
429
430
430
Be judicious with force-pushing. It is effectively re-writing published
431
- history and if anyone has fetched the old commits will have a different view
431
+ history, and if anyone has fetched the old commits, it will have a different view
432
432
of history which can cause confusion.
0 commit comments