Mattermost Logo
Edit on GitHub

Contribution Checklist

Thanks for your interest in contributing to Mattermost! Come join our “Contributors” community channel on our daily build server, where you can discuss questions with community members and the Mattermost core team.

To help with translations, see the localization process.

Follow this checklist for submitting a pull request (PR):

  1. You’ve signed the Contributor License Agreement, so you can be added to the Mattermost Approved Contributor List.
  2. Your ticket is a help wanted GitHub issue for one of the Mattermost project you’re contributing to.
    • If not, follow the process here.
  3. Your code follows the Mattermost Style Guide.
  4. Code thoroughly tested, including appropriate unit tests, end-to-end tests for webapp and manual testing.
  5. If applicable, user interface strings are included in localization files:

    5.1 In the webapp repository run make i18n-extract to generate the new/updated strings.

  6. PR is submitted against master branch.

  7. PR title begins with the JIRA or GitHub Ticket ID (e.g. MM-394 or GH-394) and summary template is filled out.

  8. Once submitted, the automated build process must pass for the PR.

  9. If your PR adds or changes a RESTful API endpoint, please update the API documentation.

  10. If your PR adds a new plugin API method or hook, please add an example to the Plugin Starter Template.

That’s all! If you have any feedback about this checklist, let us know in the Contributors channel.

To learn about the review process for each project, read the file of that GitHub repository.