docbrown/docs/getting-started/forking.md
Andy Zhao 955bdcb2bc
Update docs with Forem instead of dev.to (#9316)
* Rename all GitHub links from thepracticaldev/dev.to to forem/forem

* Use new site name

* Rename to Forem

* Rename more dev.to to forem

* Remove unnecessary redirects

* Rename DEV to Forem

* Use Forem instead of DEV for branding

* Use Forem instead of DEV for licensing

* Use seedling instead of DEV logo
2020-07-15 13:29:11 -04:00

29 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 Forem'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>/forem.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 Forem][refresh_your_fork]!
[forking]: https://help.github.com/en/articles/fork-a-repo
[fork_dev]: https://github.com/forem/forem/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