docbrown/docs/getting-started/forking.md
Jacob Herrington 7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* 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]
2019-11-26 08:40:53 -05:00

28 lines
1 KiB
Markdown

---
title: Forking the Repo
---
# Forking the repository
The first step in contributing to any Open Source project on GitHub is
[forking][forking] so that you can create [Pull Requests][pull_requests]. If
you're not familiar with the idea of forking a repository, [GitHub has a super
simple tutorial][forking_tutorial]!
If you're ready to get started, [fork DEV's repository][fork_dev]!
Once you've got a fork on GitHub, you can clone your fork to run the project
locally:
```shell
git clone https://github.com/<your-username>/dev.to.git
```
As time goes on, you may need to refresh your fork. If you have trouble with
that, you can read about [keeping a fork caught up on DEV][refresh_your_fork]!
[forking]: https://help.github.com/en/articles/fork-a-repo
[fork_dev]: https://github.com/thepracticaldev/dev.to/fork
[forking_tutorial]: https://guides.github.com/activities/forking/
[pull_requests]: https://help.github.com/en/articles/about-pull-requests
[refresh_your_fork]: https://dev.to/jacobherrington/a-fool-proof-way-to-keep-your-fork-caught-up-in-git-2e2e