Contributing to a GitHub Repo

Last modified: August 13, 2025

Introduction

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

This how-to teaches you how to do the following:

  • Contribute to a Mendix GitHub repository according to Mendix guidelines

Prerequisites

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

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 production branch.
  • To quickly create a branch based on production, use git checkout -b fix/production/my_contribution production. Avoid working directly on the production 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 was accidentally broken.

Submitting Changes

To submit changes, follow these guidelines:

  • Push your changes to the branch in your fork of the repository.
  • Submit a pull request to the appropriate repository in the Mendix organization. For more information, refer to About Pull Requests.
  • Mention the numbers of any issues that are fixed by the changes. For more information, refer to Closing Issues Using Keywords.
  • After feedback has been given, Mendix expects a response within two weeks. After two weeks, we may close the pull request if it is not showing any activity.

Read More