Contributing to a GitHub repository

Last update: Download PDF Edit

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

1. Preparation

2. Making changes to an existing repository

  • 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; git checkout -b fix/master/my_contribution master. It is advised to avoid working directly on the master branch.
  • 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 else was accidentally broken.

3. Submitting Changes

  • Push your changes to the branch in your fork of the repository.
  • Submit a pull request to the appropriate repository in the Mendix organization.
  • Mention the id’s for any issues that are fixed by the changes Closing issues with Pull Requests
  • After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn’t showing any activity.