5.71 KB
Newer Older
it33's avatar
it33 committed
1 2
# Code Contribution Guidelines

Thank you for your interest in contributing! Please see the [Mattermost Contribution Guide]( which describes the process for making code contributions across Mattermost projects and [join our "Contributors" community channel]( to ask questions from community members and the Mattermost core team.
lfbrock's avatar
lfbrock committed
4 5 6

### Review Process for this Repo

When you submit a pull request, it goes through the review process outlined below. We aim to start reviewing pull requests in this repo the week they are submitted, but the length of time to complete the process will vary depending on the pull request.
lfbrock's avatar
lfbrock committed

The one exception may be around release time, where the review process may take longer as the team focuses on our [release process](
lfbrock's avatar
lfbrock committed

#### PR submitted
lfbrock's avatar
lfbrock committed

After a PR is submitted, a core committer applies labels and notifies product managers (PMs) that there is a PR awaiting review by posting in the [PM/Docs PR Review channel](, which is a channel to discuss community pull requests that need review by PMs.
lfbrock's avatar
lfbrock committed

Then, one or more of the labels is applied:
16 17 18 19 20
 - `Awaiting PR`: Applied if the PR is awaiting another to be merged. For example, when a client PR is awaiting a server PR to be merged first. Once the PR is no longer blocked, the core committer removes the `Awaiting PR` label.
 - `1: PM Review`: Applied if the PR has UI changes or functionality that PMs can test on test servers called "spinmints".
 - `Major Change`: Applied if the PR is a major feature or affects large areas of the code base, e.g. [moving channel store and actions to Redux](
 - `Setup Test Server`: Applied if the PR is queued for PM testing.
 - `Work in Progress`: Applied if the PR is unfinished and needs further work before it's ready for review.
lfbrock's avatar
lfbrock committed

#### Stage 1: PM Review
lfbrock's avatar
lfbrock committed

24 25 26 27
A product manager (PM) will review the pull request to make sure it:
 - Fits with our product roadmap.
 - Works as described in the ticket.
 - Meets [user experience guidelines](
lfbrock's avatar
lfbrock committed

This step is sometimes skipped for bugs or small improvements with a well-defined ticket. In this case the core committer will assign the appropriate devs for review. A PM can also ask developer support to set up a separate test instance if the PR cannot be easily tested.
lfbrock's avatar
lfbrock committed

31 32 33 34 35 36 37 38
When the review process begins:
 - Mattermost Core Committer
    - Assigns `1: PM Review` label within 1 business day after the PR is submitted.
    - Assigns PM reviewer under Assignees. Those related to end user features are assigned to @esethna, others to @jasonblais. PM re-assigns as needed.
 - PM
   - Applies milestone for next release if the PM thinks there is enough time for the PR to be merged and sufficiently tested on `master` before code complete. Otherwise moved to a future release, letting submitter know that PR may have a delay in review due to the release cycle.
 - Follows up with contributor if the CLA has not been signed. If no response within 7 days, PM closes the issue.
 - PM verifies there is a corresponding JIRA ticket or GitHub issue.
lfbrock's avatar
lfbrock committed

40 41
Next, the PM tests changes on a spinmint test server:
 - PM tests and verifies pull requests via the `Setup Test Server` label. Initial review is completed within 2 business days.
 - If changes are required, PM submits review as "Changes Requested", with a comment on the areas that require updates. Comment explains why changes are needed linking back to design principles.
   - PM applies `Awaiting Submitter Action` label to more easily query the PR queue.
44 45
   - Once changes are made, PM regenerates test server and repeats testing.
 - If bugs are found that are also on `master`, a new bug report is submitted in JIRA and linked to the PR. Bugs that are also found on `master` will typically not block merging of PRs.
46 47
 - If PR is approved, PM submits review as "Approved", commenting with areas that were tested.
48 49
#### Stage 2: Dev Review

Two developers will review the pull request and either give feedback or approve the PR. Any comments should be addressed before the pull request moves on to the next stage.

52 53 54 55 56 57 58
 - PM reviewer adds `2: Dev Review` label, removes `1: PM Review` and `Setup Test Server` labels, and assigns 2 developers for review under Reviewers.
   - At least one dev is assigned based on their [feature area]( Devs re-assign as needed.
 - Devs review the code and provide feedback, with initial review completed within 2 business days. Some areas to check include:
   - Proper Unit Tests
   - API documentation
   - Localization
 - After the submitter has addressed and satisfied all reviewers' comments, `3: Ready to Merge` label is applied.
59 60 61

#### Stage 3: Ready to Merge

62 63 64
Review process is complete and the pull request is merged.

 - Dev assigns `3: Ready to Merge` label.
 - If Mattermost is not in release mode (between [major feature cut and release candidate cut](, the PR is merged into `master`.
66 67 68
 - If the PR is a major change, merge is postponed until the next release cycle.
   - Dev calls out on the issue that it is a major change and it will be merged after branching.
   - Once the current release is branched the PR can be merged into `master`.
69 70 71 72

#### PR Merged

After a PR is merged:
73 74 75
- External Contributions: PM closes the [Help Wanted] issue and related JIRA ticket.
- Internal Contributions: Core committer resolves the JIRA ticket.
- PM follows up for docs and changelog, and QA for release tests.