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

Small changes to Git Workflow docs #17662

Merged
merged 2 commits into from
Oct 16, 2019
Merged

Small changes to Git Workflow docs #17662

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cda8ac
:information_desk_person: add 'upstream' remote
dphiffer Sep 30, 2019
f440820
:bug: origin / remote
dphiffer Sep 30, 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
17 changes: 14 additions & 3 deletions docs/contributors/git-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,23 @@ To sum it up, you need to fetch any new changes in the repository, rebase your b
```sh
git fetch
git rebase master
git push --force-with-lease your-branch-name
git push --force-with-lease origin your-branch-name
```

## Keeping Your Fork Up To Date

Working on pull request starts with forking the Gutenberg repository, your separate working copy. Which can easily go out of sync as new pull requests are merged into the main repository. Here your working repository is a `fork` and the main Gutenberg repository is `upstream`. When working on new pull request you should always update your fork before you do `git checkout -b my-new-branch` to work on a feature or fix.
Working on pull request starts with forking the Gutenberg repository, your separate working copy. Which can easily go out of sync as new pull requests are merged into the main repository. Here your working repository is a `fork` and the main Gutenberg repository is `upstream`. When working on new pull request you should always update your fork before you do `git checkout -b my-new-branch` to work on a feature or fix.

You will need to add an `upstream` remote in order to keep your fork updated.

```sh
git remote add origin upstream https://github.com/WordPress/gutenberg.git
git remote -v
origin git@github.com:your-account/gutenberg.git (fetch)
origin git@github.com:your-account/gutenberg.git (push)
upstream https://github.com/WordPress/gutenberg.git (fetch)
upstream https://github.com/WordPress/gutenberg.git (push)
```

To sync your fork you need to fetch the upstream changes and merge them into your fork. These are the corresponding commands:

Expand All @@ -57,7 +68,7 @@ This will update you local copy to update your fork on github push your changes
git push
```

The above commands will update your `master` branch from _upstream_. To update any other branch replace `master` with the respective branch name.
The above commands will update your `master` branch from _upstream_. To update any other branch replace `master` with the respective branch name.


## References
Expand Down