Skip to content
Lieven Hollevoet edited this page Aug 31, 2013 · 4 revisions

To contribute code you generate a so-called pull request. A pull request allows the other developers to evaluate the changes you propose to do to the code. This page details how to create a valid pull request.

First of all, it is assumed that you have been following the directions on this page to add your modifications. Steps you should not miss are:

  • clone the original hollie/misterhouse repo to your own github account.
  • checkout the 'master' branch as this is the branch on which development is taking place.
  • create a new branch (which is called a feature branch) from master where you make your changes in. Pick a short but descriptive name. Creating this feature branch is important as it is required for you to be able to create a pull request specifically for the change you want to apply.
  • commit the feature branch to your github repo.

Now you're ready to create the pull request through the web interface of github:

  • Navigate to the feature branch in your repo and click the 'generate pull request button. Generate pull request
  • By default the pull request will be generated against the 'stable' branch of hollie/misterhouse. This is not the correct branch as we're developing on 'master'. Edit the pull request accordingly. Edit the pull request and Select the master branch
  • Add context to your pull request (if it is not already generated from the commit message you added, you can do that by using the well-formatted commit messages) and generate the pull request. Select the master branch

Optionally, notify the mailing list to ensure everybody knows an incoming pull request is available for testing.

More info on using pull requests from github is also an interesting read.

Clone this wiki locally