Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 2 KB

FORK_CLONE_REMOTE.md

File metadata and controls

51 lines (30 loc) · 2 KB
Raw

Fork, Clone & Remote

Fork

Note: This is only needed if you want to contribute to the project.

If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the Fork button that can be found on the top right corner of the landing page of the repository.

For example:

image

Clone

Note: For this you need to install git on your machine. You can download the git tool from here.

  • If you have forked the project, run the following command -

git clone https://github.com/YOUR_GITHUB_USER_NAME/<Respository_Name>

where YOUR_GITHUB_USER_NAME is your GitHub handle and <Project_Name> is name of Project you are trying to Clone.

  • If you haven't forked the project, run the following command

git clone https://github.com/anitab-org/<Project_Name>

<Project_Name> is name of Project you are trying to Clone, for example, mentorship-backend

Remote

Note: This is only needed if you want to contribute to the project.

When a repository is cloned, it has a default remote named origin that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command -

git remote add upstream https://github.com/anitab-org/<Project_Name>

You can check that the previous command worked by running git remote -v. You should see the following output:

$ git remote -v
origin  https://github.com/YOUR_GITHUB_USER_NAME/<Project_Name> (fetch)
origin  https://github.com/YOUR_GITHUB_USER_NAME/<Project_Name> (push)
upstream        https://github.com/anitab-org/<Project_Name>.git (fetch)
upstream        https://github.com/anitab-org/<Project_Name>.git (push)