Git Commands to Work on GitHub¶
As research becomes increasingly collaborative and multiple people work on the same project, it becomes difficult to keep track of changes made by others if not done systematically. Moreover, it is time-consuming to manually incorporate the work of different participants in a project, even when all of their changes are compatible. Hosting the project on an online repository hosting service like GitHub is beneficial to make collaborations open and effective. If you are new to collaboration through GitHub, please follow the comprehensive guide in the previous sections.
In this section, we will discuss how to use Git commands to work with an online Git repository.
Please note that the commands listed in this chapter (both in this and previous subchapters) are NOT specific to GitHub. They are used for collaborative work on any Git repositories and to interact with any repository hosting site/servers, which can be GitHub, but also GitLab, Bitbucket or a self-set-up bare Git repository on a web server.
For simplicity, we will use GitHub as an example to explain commands that are used for interacting with Git repositories.
Create a Local Copy of an Online Repository¶
So far, all Git commands introduced in this chapter concerned local, unconnected Git repositories.
In order to collaborate with others, hosting services, such as GitHub, can store a clone (a copy) of your local repository and expose it to others.
Usually, you will have a local repository and a remote, web-hosted repository.
Your local repository is connected to the web-based clone.
In technical terms, the web-based clone is a
remote of the local repository. Usually, this remote is called “origin”.
Having a web-based remote allows you to push changes to your project online.
It enables others to obtain their own clone of your repository (a copy of your repository to their local computer), make changes, and submit a pull request that allows you to integrate their changes.
For example, one can create an independent local copy of a project using the following Git command:
git clone <insert GitHub link of the repository here>
Collaborators can update their local version of an online repository or pull other’s work into their copy using the command:
Similarly, they can edit files locally and stage their updates (
git add .), commit changes to a new version (
git commit) and push changes to the remote online repository using the Git command:
Contributing to Other Projects¶
When you create a local copy of a repository, you only keep the versions of the files that are in the repository at the time of creating that copy. If any changes are made in the original repository afterwards, your copy will get out of sync out-of-sync. This can lead to problems like conflicting file contents when making a pull request or merging changes from your branch to the main repository. Therefore, when working on different branches or forks of a repository, it is a good practice to keep them updated with the master repository and in sync with the original repository.
A Workflow to Contribute to Others Github Projects via
Using the fork button on the GitHub repository you wish to contribute to, create a copy of the repository in your account. The master repository that you forked will be referred to as the “upstream” repository.
You can now work on your copy using the command line, via the following steps:
Clone it to your local machine:
git clone firstname.lastname@example.org/your_username/forked_repository.git
Add the ‘upstream’ repository to the list of remote repositories using a similar command as below (replace the upstream repository’s users id and original repository name):
git remote add upstream https://github.com/upstream_user's_username/original_repository.git
Verify the new remote ‘upstream’ repository:
git remote -v
Update your fork with the latest upstream changes, by first fetching the upstream repository’s branches and latest commits to bring them into your repository:
git fetch upstream
View all branches, including those from upstream:
git branch -va
Make sure that you are on your master branch locally, if not, then checkout your master branch using the command
git checkout master
Keep your fork updated by merging those commits (fetched from the upstream) to your own local master branch.
git merge upstream/master
Now, your local master branch is up-to-date with everything modified upstream. If there are no unique commits on the local master branch, git will simply perform a fast-forward.
Note: The upstream/master is the original repository’s master which you wish to contribute to, whereas origin/master refers to the repository you cloned in your local machine after it was forked on GitHub.
Once your fork is in sync with the upstream master repository, you can always keep your local cloned repository in sync with origin (fork in this case) by using:
git checkout master git pull
git pull command combines two other commands,
git fetch and
git fetch, the resulting commits are stored as the remote branch allows you to review the changes before merging.
Similarly, if you have created more branches other than master, you can also keep them in sync with your master, once it is in sync with the upstream repository.
git checkout my-other-branch git pull origin master
When everything is up-to-date, you can work on your branch and commit changes.
When you are ready to push your local commits to your forked repository (origin), use the following command.
git push origin forked_repository
Now you can make a pull request!
Before you create a branch, make sure you have all the upstream changes from the origin/master branch.
A word of caution on the
rebase command: While trying to keep your branches in sync, you may come across the
It tends to rewrite history and could be troublesome if not communicated with others working on the same branch. Try to avoid using the
rebase command, and instead use
merge, as discussed in this section.
You can find more details about Merging vs Rebasing here