Skip to content

Files

Latest commit

6531a0f · Nov 1, 2015

History

History
108 lines (67 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

108 lines (67 loc) · 3.49 KB

Contributing to Mosquitto

Thank you for your interest in this project.

Project description:

The Mosquitto project has been created to provide a light weight, open-source implementation, of an MQTT broker to allow new, existing, and emerging applications for Machine-to-Machine (M2M) and Internet of Things (IoT).

Source

The Mosquitto code is stored in a git repository. The URL for anonymous access is:

Access via Gerrit (for code review) is through the following URLs:

A web browsable repository is available at

Contributing a patch

The Mosquitto repositories are accessed through Gerrit, the code review project, which makes it possible for anybody to clone the repository, make changes and push them back for review and eventual acceptance into the project.

To do this, you must follow a few steps. The first of these are described at

  • Sign the Eclipse CLA
  • Use a valid commit record, including a signed-off-by entry.

There are further details at

If your contribution is a fix for a bug, please use the 'fixes' branch as the base for your work. If you are proposing new behaviour/features please use the 'develop' branch.

Once the patch is pushed back to Gerrit, the project committers will be informed and they will undertake a review of the code. The patch may need modifying for some reason. In order to make amending commits more straightforward, the steps at https://git.eclipse.org/r/Documentation/cmd-hook-commit-msg.html should be followed. This automatically inserts a "Change-Id" entry to your commit message which allows you to amend commits and have Gerrit track them as the same change.

What happens next depends on the content of the patch. If it is 100% authored by the contributor and is less than 1000 lines (and meets the needs of the project), then it can be committed to the main repository. If not, more steps are required. These are detailed in the legal process poster:

Developer resources:

More information regarding source code management, builds, coding standards, and other topics can be found at.

Contributor License Agreement:

Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation Contributor License Agreement (CLA).

Contact:

Contact the project developers via the project's "dev" list.

Search for bugs:

This project uses Bugzilla to track ongoing development and issues.

Create a new bug:

Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!