Skip to content

Commit ea086e1

Browse files
Jeff Yangvfdev-5
andauthored
[contributing] add syncing up with the upstream (#1452)
* Update setup.cfg * [contributing] add syncing up with the upstream * Apply suggestions from code review Co-authored-by: vfdev <[email protected]> * Update CONTRIBUTING.md Co-authored-by: vfdev <[email protected]>
1 parent 44f354e commit ea086e1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,30 @@ If you are not familiar with creating a Pull Request, here are some guides:
167167
- http://stackoverflow.com/questions/14680711/how-to-do-a-github-pull-request
168168
- https://help.github.com/articles/creating-a-pull-request/
169169

170+
##### Sync up with the upstream
171+
172+
First, make sure you have set [upstream](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork) by running:
173+
174+
```bash
175+
git remote add upstream https://github.com/pytorch/ignite
176+
```
177+
178+
Then you can see if you have set up multiple remote correctly by running `git remote -v`:
179+
180+
```bash
181+
origin https://github.com/{YOUR_USERNAME}/ignite.git (fetch)
182+
origin https://github.com/{YOUR_USERNAME}/ignite.git (push)
183+
upstream https://github.com/pytorch/ignite (fetch)
184+
upstream https://github.com/pytorch/ignite (push)
185+
```
186+
187+
Now you can get the latest development into your forked repository with this:
188+
189+
```bash
190+
git fetch upstream
191+
git checkout master
192+
git merge upstream/master
193+
```
170194

171195
### Writing documentation
172196

0 commit comments

Comments
 (0)