IntenseWebs/mattermost
3
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2025-02-25 18:55:24 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
9828d84f01147ffb87b372d20681f91325ecfcf0
mattermost/doc/developer/code-contribution.md
it33 3d597905fb Create code-contribution.md
2015-09-12 00:43:03 -07:00

2.4 KiB
Raw Blame History

Code Contribution Guidelines

Thank you for your interest in contributing to Mattermost. This guide provides an overview of important information for contributors to know.

Choose a Ticket

  1. Review the list of Good First Contribution tickets listed in Jira.

  2. These projects are intended to be a straight forward first pull requests from new contributors. If you don't find something appropriate for your interests, please see the full list of tickets Accepting Pull Requests.

  3. If you have any questions at all about a ticket, please post to the Contributor Discussion section of the Mattermost forum, or email the Mattermost Developer Mailing list.

Install Mattermost and set up a Fork

  1. Follow developer setup instructions to install Mattermost.

  2. Create a branch with set to the ID of the ticket you're working on, for example PLT-394, using command:

git checkout -b <branch name>

Programming and Testing

  1. Please review the Mattermost Style Guide prior to making changes.

  2. Please make sure to thoroughly test your change before submitting a pull request.

Submitting a Pull Request

  1. Please add yourself to the contributor list prior to submitting by completing the contributor license agreement.

  2. When you submit your pull request please include the Ticket ID at the beginning of your pull request comment, followed by a colon.

For example, for a ticket ID PLT-394 start your comment with: PLT-394:. See previously closed pull requests for examples.

  1. Once submitted, your pull request will be checked via an automated build process and will be reviewed by the Mattermost core team, who may either accept the PR or follow-up with feedback.

  2. If you've included your mailing address in Step 1, you'll be receiving a Limited Edition Mattermost Mug as a thank you gift after your first pull request has been accepted.