Contribute to a GitHub Repository

Last update: Edit

1 Introduction

We like to work with our community, and we encourage you to create and contribute using pull requests!

This how-to will teach you how to do the following:

  • Contribute to a GitHub repository according to our guidelines

2 Prerequisites

Before starting with this how-to, make sure you have completed the following prerequisites:

3 Making Changes to an Existing Repository

To make changes to an existing repository, follow these guidelines:

  • Create a new branch from where you want to base your work on your fork (this is usually the repository’s master branch)
  • To quickly create a branch based on master, use git checkout -b fix/master/my_contribution master
    • Avoiding working directly on the master branch is adivsed
  • Make commits of logical units
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure you have added the necessary tests for your changes
  • Run all the tests to assure nothing was accidentally broken

4 Submitting Changes

To submit changes, follow these guidelines:

5 Read More