mattermost / mattermost/mattermost-plugin-github

Use custom post type to display TODO list

Open
#86 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Difficulty/1:Easy Good First Issue Hacktoberfest Help Wanted Tech/Go Tech/ReactJS Type/Enhancement Up For Grabs
Dominant language
Go
Stars
179
Forks
180
Avg merge
1d 16h
Merged PRs (30d)
13

Description

Currently, the TODO list that gets posted daily or by /github todo looks something like this:

Screen Shot 2019-06-04 at 16 41 25

This works ok but it's hard to read, is only minimally functional and I think we can add something that does way better. Plugins have a cool feature that lets you use custom post types to render your own React components in place of the regular post components. Leveraging this we can:

  1. Display way more information about the pull requests/issues upfront in a much more readable way
  2. Add more functionality, such as a button to open all the unread messages so users don't have to click through each one

I started working on this in the unreads-v2 branch with the following commit https://github.com/mattermost/mattermost-plugin-github/commit/54e8ecf1f797ad517f362e40424cea4b78eba371 but stopped for two reasons: 1) I ran out of time and 2) plugins could not use custom post types for ephemeral messages (which the /github todo command returns). As of the next Mattermost version 5.12 coming out soon, 2) is possible thanks to https://github.com/mattermost/mattermost-webapp/pull/2759. Unfortunately, 1) is still the case as I'm still a bit too busy to work on it.

If someone is interested in picking up where I left off I think this would be a really great feature that would take the GitHub plugin to the next level. It'll require a bit of everything from server side, front end, UX design and merging master into my branch.

Here's what it was looking like when I stopped:

Screen Shot 2018-11-11 at 15 55 15

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 unreads-v2 branch and commit 54e8ecf1f797ad517f362e40424cea4b78eba371, then trace the daily TODO flow and the /github todo command. Done means both paths render the TODO list with a custom post type, expose the proposed unread-message action, and work for ephemeral messages on Mattermost 5.12 or later.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, react
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.