Mattermost Community playbook
This playbook outlines various processes and practices used in the Mattermost community, including running community design meetings and campaigns, managing GitHub and forum issues, and managing Twitter.
- 1.Avoid blindspots in design by shaping requirements and use cases with user communities.
- 2.Confirm proposed approach for design aligns with solving the problem discussed.
- 3.Brainstorm ideas for solving open design questions.
- 1.Research existing solutions to understand potential use cases brought up by communities.
- 2.Draft a proposed design for the problem - this can be a rough outline, more concrete mockups or final design.
- 3.Decide two meeting times: one for European and Asian communities, another for North and South American communities.
- Avoid regional holidays.
- Aim for typical working hours in the countries/regions.
- 4.Prepare agenda.
- Introductions of Mattermost team members part of the meeting.
- Review of use cases.
- Review of proposed design approach.
- Open discussion and Q&A.
- Actions and decisions.
- Review of next steps.
- 5.Create a public meeting link everyone has permission to access, such as a Zoom link.
- 6.
- 1.
- 2.
- 3.
- 4.
- 5.Ask customer success teams to share with interested customers.
- 1.Record the meeting. Mention that sharing video is optional.
- 2.Follow the agenda.
- 3.Thank everyone for joining the call.
- 1.Share a summary in all respective channels, including the meeting recording.
- 2.Send a survey asking how valuable the meeting was, feedback on additional use cases, and feedback on improving the meeting in the future. See example here.
- 1.Do not use your personal Zoom meeting link for the call.
- 2.Note in all announcements that sharing video is optional.
- 3.Use
Mattermostin your name to identify staff from community members on the call. - 4.Consider sequencing design review meetings with design priorities.
- 5.Encourage less vocal attendees to share feedback via written chat.
Examples include React Native Apps, Redux, and APIv4 campaigns.
- 1.Create a blog post for the Developer Blog letting developers know about the campaign and ways to contribute.
- 2.Create a contribution guide. This can be part of the blog post.
- 3.Create Help Wanted tickets that a community member could work on.
For a high priority Help Wanted ticket, reach out to contributors directly in the GitHub repository for best engagement.
- 1.Identify active contributors and thank them personally for their work.
- 2.For Work in Progress tickets or submitted pull requests, follow up with contributor once a week for status updates and questions to make sure contributors aren't blocked and feel comfortable asking questions. If there hasn't been activity in more than two weeks, ask if you can help them in some way.
- 3.Recognize everyone’s contributions (either intrinsic rewards like having their name listed on a contributor’s page or tangible like swag or gift cards).
- 4.If applicable, assign roles to top contributors (such as team lead, code reviewer, tester) to give a sense of ownership to the contributor.
When a campaign is finished, offer suggestions for other campaigns or projects they might be interested in.
Increase Mattermost usage through larger and more numerous deployments via a vibrant open source community that contributes features that would not otherwise be offered.
- Contributors get a worthwhile benefit from their contributions, from the feature directly and/or from social recognition.
- Community members should have a low barrier to contribute.
- Community development workflow should be clear, efficient and effective.
- Help Wanted issues should avoid updates to the Enterprise repository due to complexity in code changes and unit tests.
- 1.Create a ticket in Jira that is well-defined and unambiguous.
The issue should be written with the mindset that the contributor might have no or limited experience with the Mattermost code base and limited exposure to the Mattermost product.
Note: Below are a few reasons why Jira tickets for Help Wanted issues are recommended:
- Jira tickets can be used to prioritize Help Wanted issues internally and are easily searchable by Mattermost staff, community, and customers.
- Zapier integration automatically creates GitHub Help Wanted issues from labelled Jira tickets, requiring no additional mana.
- Resolved Jira tickets are automatically assigned to a QA, who tests them against the
masterbranch. - After creating the ticket, add "(Proposed APR)" to its title, so the triage team knows to consider it for a
help-wantedlabel. - If the Jira ticket is accepted as a Help Wanted issue during triage, a
help-wantedlabel is added. This action automatically triggers a zap that creates a new issue in the mattermost-server repository.- To accept a ticket as a Help Wanted issue, the description should be unambiguous, and include UI description and help text so the change can be implemented and tested by any contributor.
- The Triage team also adds the appropriate difficulty level (one of
Introductory,IntermediateandAdvanced) and programming language (GoandReactJS) to the description of the Jira ticket.
- After triage, the PM on community rotation reviews formatting of the GitHub issue and adds appropriate labels for difficulty level and programming language as defined by the Triage team.
Once a Help Wanted issue is added, the PM on community rotation is responsible for:
- Answering questions from community members, which get automatically posted in the Community Heartbeat channel.
- Following up with a community member if there hasn't been a response for more than two weeks.
Once a pull request for an open GitHub Help Wanted issue is merged, please ensure:
- The corresponding GitHub Help Wanted issue is closed, thanking the contributor.
- The corresponding Jira ticket is resolved.
Below is a list of permanent redirects to Help Wanted issue queries:
- Support (answer everything correctly)
- Prioritize (focus help on those who help others)
- Empower (give them time to answer)
- Elevate (thank, recognize and approve their work)
- Grow (invite people to help as experts, promote people)
- Don't answer if unsure
- Ask someone who knows for sure instead of replying with an assumption or incomplete understanding.
- Don't be afraid to re-route if you don't have the answer and are having trouble figuring it out.
- Don't make promises
- Don’t say “we’ll work on it” or something similar that sets expectations that aren’t met later (e.g. after presenting to core team it turns out you can’t do it).
- Be careful saying “that’s a good idea”, don’t just say it to be polite. Instead say something akin to “thanks for the idea”.
- Choose positivity over negativity
- Avoid excuses like “we’re busy”, or “our team is small” and turn a missing feature into an invitation to share a feature idea to be upvoted.
- Do your best to link documentation as answers
- Allows answers to be easily updated dynamically as documentation is updated.
- Any questions that should be answered in docs that aren’t should turn into tickets to create that documentation (and post ticket in response).
- Keep community end-user information secure
- If you come across a post that includes the person's IP address, domain name, or other information you think should not be disclosed publicly, edit the post to remove this information. Then click the hide revision button so that your edits won't be visible to others on the forum.
- Be thankful
- Communities really respond well to being praised and thanked for their work.
- 1.If an issue has a PR submitted by community, but no associated Jira ticket, leave it open until the PR is merged.
- 2.If an issue has a Jira ticket with a
help-wantedlabel, there is a Help Wanted ticket in GitHub. It can be closed with the following note:
Hi @username Thanks for the report! We have created a Help Wanted issue here and are looking for community's help. Would you be interested helping with a pull request?
- 1.If an issue has a Jira ticket without a
help-wantedlabel and assigned to the current release fix version for a developer to fix, it can be closed with the following note:
Hi @username Thanks for the report! We have created a Jira ticket to track it. If you're interested helping with a pull request, please let us know.
- 1.If an issue has a Jira ticket without a
help-wantedlabel but not assigned to the current release fix version, queue Jira ticket back to triage to ask if a Help Wanted issue could be created for it. - 2.If the reporter doesn’t respond in two weeks, close the issue with the following note:
Hi @username, we haven't received an update so we'll assume that the problem is fixed or is no longer valid. If you still experience the same problem, try upgrading to the latest version. If the issue persists, reopen this issue with the relevant information and we'd be glad to help you where we can.
Respond to the issue with the following note:
Thanks, appreciate your feedback @{username}. Would you like to contribute this in the feature idea forum so it can be discussed, upvoted, and considered for a Help Wanted ticket? Please include a link back to this GitHub issue. If you're interested in implementing, please say so and we'll prioritize the review.You get 10 votes in the feature idea forum, and each one influences the future of the project.
To ask someone to add a license to a GitHub repo, open an issue with the following note, titled
Add an open source license?:Thanks for sharing this project! We'd love to use it as part of the Mattermost open source project (https://mattermost.com/) in our React Native mobile app (which uses an Apache 2.0 license). Would you consider adding a license, such as an MIT or an Apache 2.0 license? To do so, in GitHub you can hit "Create new file" and name a fileLICENSE.txt.This will prompt GitHub to offer a license template:If you use a license it would make it easy to promote your open source project with the Mattermost community.Thanks kindly for your consideration.
To respond to tough questions, use the SCIPAB method to help formulate a response and send for community lead to review.
- Situation: State what you know about your listeners' circumstances that are relevant to your discussion or presentation, e.g., current state of their business, technology, industry, or plans.
- Complication: Identify the critical issues (changes, pressures, demands, etc.) that are impacting the Situation and creating problems, challenges, or opportunities.
- Implication: Show the personal or business consequences of failing to act on the problems or opportunities described in the Complication.
- Position: State clearly and confidently your opinion about what needs to be done to solve your listeners' problem.
- Action: Help listeners understand the role you want them to play, or the questions you'd like them to consider, during your presentation or conversation.
- Benefit: Describe how your recommended Position and Action will address listeners' specific needs. State the results clearly and quantifiably.
- 1.Avoid acronyms. Avoid acronyms when possible. For example, say "pull request" instead of "PR", since only a subset of tweet readers are active GitHub users.
- 2.Use the active voice. Avoid "has", "was", "have been" when possible. For example, instead of "Hackfest has started!" say "Hackfest starts now!"
- 3.Include at most one link. To provide a clear call to action, include at most one link per tweet and place it near the end of the tweet.
- 4.Use exclamation marks only for exciting announcements. An exclamation mark can be used when the announcement is exciting, but using an exclamation mark should be avoided when it can be confused with a signal for community to panic, e.g. "Security update released!".
- 5.Be welcoming. When asking someone to take action, use "Would you be open to" instead of "Would you like to".
- 1.When to like (heart) a tweet where Mattermost is mentioned?
- Our team is on site at an event and tags our handle.
- A community member shares an event we are at, received a Mattermug, or shared a positive experience and mentions us.
- 2.When to retweet a post?
- A community member released an integration and mentions us.
- Mattermug tweets from community members.
Thank you for your interest in Mattermost. You can learn more about us at https://mattermost.com/ where you can also download a trial of our product.
- Multiple Feature Requests:
Thank you for the suggestions @username. Would you be open to contributing them in the feature idea forum so they can reviewed by our Product Management team? We use the collective feedback of our users to influence the future of the project._ What Matters to You Portal.
- Single Feature Request:
Thank you for the suggestion @username. Would you be open to contributing it in the feature idea forum so it can reviewed by our Product Management team? We use the collective feedback of our users to influence the future of the project._ What Matters to You Portal.
- Planned Feature Request:
Thank you for your feedback. We are excited to share that [feature] will be available in our [edition] Edition soon. Please see our forum post for more information: [link to forum post].
- Shipped Feature Request:
Thank you for your feedback. Mattermost already supports [feature]. You can learn more about it in our documentation: [link to docs].
Appreciate the feedback. If your team has suggestions on how to improve Mattermost, we would love to hear more in our feature proposal forum. You get 10 votes there, and each one influences the future of the project: https://mattermost.uservoice.com/.Thanks @{username}, highly appreciate your feedback. If you have additional feedback about your experience, we'd love to hear. You can share at http://forum.mattermost.org to start a discussion.
Thank you for reaching out. Our team responded to you in the forums and we're happy to help with further questions there.Thank you for reaching out. Our team monitors and responds to forum inquiries. We're happy to help with further questions there.
Thank you for reaching out. We recommend opening a support ticket where our team can best help you troubleshoot the issue. For more information about Enterprise Edition support levels, see https://about.mattermost.com/support/.
Content in any community site managed by Mattermost should follow the guidelines above. Content that is deemed to be controversial, offensive, potentially defamatory or infringing content from material distributed, broadcast, or posted on websites will be edited or removed.
We ask the community's help in reporting any such content to [email protected]
Last modified 3mo ago