Fork, branch, track, squash and pull request
This guide will teach you how to properly contribute to open source projects on GitHub. It assumes that you already know about how to use Git for version control and that you already have a GitHub account.
GitHub is pretty great about giving advice to users starting new repositories, but it isn’t very helpful when it comes to contributing changes back to other projects. Hopefully, this guide will help.
Before you get started, find the page of the project you’re looking to improve. Poke around in the code a little bit, familiarize yourself with their development styles, check the commit log to see who is contributing and check out the profile of the core maintainer.
Check the Network to study other Github forks
The first thing to do is check the Network tab on the project to see all the other forks that other people have made. Spend a few minutes digging around in them, as it’s quite possible that somebody is already working on the problem that you’d like to see solved. It’ll also give you an idea of the activity of the project, and how likely it is that your changes will be merged in.
Open an issue before making your Git fork
Next, head over to the Issues tab. Have a look around, see how many issues there are and if anybody has opened up the issue that you’re interested in working on.
This is an important step that many people forget about, and they just submit major pull requests to maintainers without considering that the maintainers might not have the same intentions with the software as they do. This is especially true if a new feature requires user interface/design changes, as often, that’s the aspect of programs that people are the most protective of.
If your issue doesn’t exist already, open up a new issue. Standard human interaction rules apply here; be friendly, be polite, say thanks for making the project, describe the bug or feature you’d like to work on and then offer to help.
Hopefully, they’ll reply shortly with some input on how to solve the problem.
How to fork a repo in github
Here’s the fun part! Hit ‘Fork’. Now you’ve got your own version! Go to the page, get the ssh: url from the box at the top and then
git clone **your ssh/git url**
to your local machine. Hooray! You have the code on your local machine now.
Add the Upstream as a remote Github Branch
This step isn’t absolutely necessary, but I find it very useful if you plan on working on this project for anything more than a very quick fix. Use the following commands to add the ‘upsteam’ (original project location) as a remote branch. This will allow you to get their Github updates into your fork or branch. Replace the ‘upstreamname’ and ‘projectname’ values with that actual user/project name that you’re trying to track.
|git remote add –track master upstream git://github.com/upstreamname/projectname.git|
This will add the original project as a remote named ‘upstream’. To get the code, type:
git fetch upstream
Then, to merge it into your own project, type:
git merge upstream/master
Tada! Now you’ll have an up-to-date version of the upstream code in your current branch.
Setting Up Development Github Branches
Now you’re getting ready to start hacking, you’ll want to switch off of the ‘master’ branch and onto a different branch for your new feature. It’s important to do this because you won’t get multiple pull requests. In fact, you can only have one Pull Request per branch, so if you want to submit more than one fix, you’ll need to have multiple branches. Make a new branch like this:
git branch newfeature
Then switch to it like this:
git checkout newfeature
Now you’re on your new branch. You can confirm this by simply typing ‘git branch’.
Hack your fork in Git
This part’s up to you. Hack along as you normally would until the code is in the state where you’re happy with it, it performs the task as described and it passes all the tests you’ve written for it. Yayyyy!
If you’re a heavy committer in Github, squash commits
If you’re a heavy committer like me, you’ve probably got lots of poorly messaged commits (‘works!’, ‘broken’, ‘fuck’, ‘woo’, etc.). This is a bad habit, but I haven’t been able to break it yet and I know I’m not the only one!
Before you submit your pull request back upstream, you’ll want to squash these commits into a small handful of well-labeled commits. To do this, we’re going to use the git rebase command. First, take a look at the commits we’ve made with git log and figure out the commits that we want to squash. If we wanted to squash the last 3 commits into one, we’d open up an an interactive rebase like this:
git rebase -i HEAD~3
This will bring you into your editor with some text that will look something like this:
pick df94881 Allow install to SD pick a7323e5 README Junkyism pick 3ead26f rm classpath from git
To squash those commits into one, change to something like this:
pick df94881 Allow install to SD squash a7323e5 README Junkyism squash 3ead26f rm classpath from git
Then, save/quit, and you’ll be brought to into another editor session. Describe the changes as well as you can and save/quit again. Hooray! You’ve squashed your ugly commits into one nice one. Now you’re ready to submit a pull request in Git.
How to make a pull request in Github
Once you’ve committed and squashed your changes, push them to your remote like this:
git push origin newfeature
Then go to that page on GitHub and change branches to the one for your new feature.
Then, click on the little button that says ‘Pull Request’. This will bring you to a page asking you to describe your change in Github. Create a pull request by clicking on the button saying “send pull request” but make sure that your description of the changes is thorough.
Hooray! You did it. Now, you’re not quite done yet. If the maintainer finds some problems with your code, they won’t want to pull your changes until you fix them. Fortunately, whenever you commit and push more things to that branch of your code, they will be included in that pull request until it is closed.
Accepting And Merging a Github Pull Request
Bonus! If you’re on the receiving end of a pull request, how do you merge the changes? Easy – press the button! GitHub now has an auto-merge button which does everything for you in one click. However, it doesn’t always work, in which case you’ll have to do the merge on your own machine, like so:
git checkout master git remote add contributor git://github.com/contributor/project git fetch contributor git merge contributor/newfeature git push origin master
And then their changes will be properly merged into your main master branch.
So, Your Github PR Was Rejected. Now What?
Sometimes, for technical or organizational reasons, your pull request will be rejected. This can feel really frustrating, and there are a few different ways you can proceed. Just remember to act rationally.
The simplest thing is to simply accept their judgement. It’s their project, and a good maintainer knows when to say “no.” If their argument is logically sound, you should accept it. If you don’t think it’s a particularly important feature, hopefully whoever is looking at the project will check the Network and Issues tabs of the upstream project and will notice your changes. However, I think this is a pretty poor solution in cases when the upstream maintainer is wrong or unresponsive.
A better thing to do is write about it. Write about it on your blog, start a discussion on a mailing list, and solicit opinions from the community about what the best way to proceed is. If you don’t have a destination to share on yet, then take the initiative to start a blog and make this your first post. It’ll also give some Google-juice to your project/issue, which will help other people who ran into the same problem you faced.
The last option is to sever ties with the upstream and declare yourself the new maintainer of the project. This should only be as a last resort and should only really be done when the upstream project is dead or has gone completely off the rails. That being said, this kind of software deadheading can actually breathe a lot of new life into a project – just look at how LibreOffice has managed to revive the OpenOffice project by severing ties with Oracle.
If you do this, you should rename your project to differentiate it from the upstream, explicitly state your reasons for the schism in your README, and be sure to give proper copyright credit according the the open source license they originally chose. Maintaining an open source project carries quite a lot of responsibility, so make sure you’re prepared to care for the project once you create such a schism.
Hopefully this little guide was useful for getting you started with collaborative software development on GitHub!