7d0aeeefe5
* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
55 lines
1.1 KiB
Markdown
55 lines
1.1 KiB
Markdown
---
|
|
title: Keeping Your Fork In Sync
|
|
---
|
|
|
|
# Keeping your fork in sync
|
|
|
|
Now that you have a fork of DEV's source code, there is work you will need to do
|
|
to keep it updated.
|
|
|
|
## Setup your upstream
|
|
|
|
Inside your DEV directory, add a remote to the official DEV repo:
|
|
|
|
```shell
|
|
git remote add upstream https://github.com/thepracticaldev/dev.to.git
|
|
```
|
|
|
|
## Rebasing from upstream
|
|
|
|
Do this prior to creating each branch for a PR:
|
|
|
|
Make sure you are on the master branch:
|
|
|
|
```shell
|
|
$ git status
|
|
On branch master
|
|
Your branch is up-to-date with 'origin/master'.
|
|
```
|
|
|
|
If you aren't on `master`, finish your work and checkout the `master` branch:
|
|
|
|
```shell
|
|
git checkout master
|
|
```
|
|
|
|
Do a pull with rebase against `upstream`:
|
|
|
|
```shell
|
|
git pull --rebase upstream master
|
|
```
|
|
|
|
This will pull down all of the changes to the official `master` branch, without
|
|
making an additional commit in your local repo.
|
|
|
|
(Optional) Force push your updated `master` branch to your GitHub fork
|
|
|
|
```shell
|
|
git push origin master --force
|
|
```
|
|
|
|
This will overwrite the `master` branch of your fork.
|
|
|
|
## Additional resources
|
|
|
|
- [Syncing a fork](https://help.github.com/articles/syncing-a-fork/)
|