mattermost / mattermost/mattermost-developer-documentation

Document help wanted issue creation process

Open
#340 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Content
Dominant language
CSS
Stars
90
Forks
460
Avg merge
9d 23h
Merged PRs (30d)
2

Description

Contributions without tickets, including raising a proposal for a help wanted issue, are documented here

https://developers.mattermost.com/contribute/getting-started/contributions-without-ticket/

However, core committer process for creating these Help Wanted issues is not documented. Propose we do so. The process is roughly:

  1. Create a Jira issue with a clear title and description, including any information that would help a contributor get started.
  2. If applicable, have the issue reviewed by a PM or another core committer
  3. Add "Help Wanted" fix version, which automatically creates a Help Wanted GitHub issue for that Jira issue. This automation is done via the Zapier tool.
  4. Follow up on questions from contributors on the help wanted issue

Note: As of August 6, the Zapier automation is broken due to an issue on Zapier's end. Hence, you will need to create the issue manually on step 3. For an example issue with an intro that helps new contributors to get started can be found here: https://github.com/mattermost/mattermost-server/issues/11675

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the contributions without a ticket and core committers pages linked in the issue, then review example GitHub issue #11675. Document the core committer process for creating Help Wanted issues, including Jira preparation, review, the Help Wanted fix version or manual creation while Zapier is broken, and contributor follow-up; done means the process is clear and current.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.