Contributing to Open Source

This is a sort of note-to-self outlining the steps to contribute to open-source projects. The information is based on the excellent article by Steve Klabnik, and I felt it was worth repeating here.

First, fork the project on GitHub.

Clone the repo to your computer:

$ git clone git@github.com:your_name/project.git

Keep track of changes by creating an upsteam to the original repo:

$ cd dup_finder
$ git remote add upstream https://github.com/mfueger/project.git
$ git fetch upstream

Create a new feature branch for the changes you’re planning to make:

$ git checkout -b feature/new-feature
(add new files or make changes)
$ git add *changes*
$ git commit -m "additions and changes"

Push changes to GitHub:

$ git push origin feature/new-feature

And finally, issue a pull request from your repo’s feature branch ;–)

blog comments powered by Disqus