Mattermost-plugin-github: Links in todo messages should be consistent, include repo info

[levb]

The output of /github todo lists PRs, and assignments differs from that of Messages.

1. They should be consistent
2. They should include both the repo reference, and the PR title.
3. bonus: Unread messages should indicate if PR or Issue

Suggested format: [org/repo-last-token-ellipsis](repoURL)[PR/IssueID title](issueURL)
The repo name should be parsed, and shortened to its last word, with an ellipsis prepended if truncated. The title should probably be truncated at say 256 characters, just in case?

example:

Unread Messages

You have 8 unread messages:

• mattermost/...server #10438 Rewrite existing plugin API tests to exclusively test via actual plugin
  ...

Review Requests

You have 1 pull requests awaiting your review:

• mattermost/...zoom #45 Added webhook info

Your Open Pull Requests

You have 2 open pull requests:
...

[levb]

cc @aaronrothschild @asaadmahmood for copy/formatting suggestions

[aaronrothschild]

Bonus Bonus: I will go on a limb and say that it may be useful to GROUP the messages/issues/PRs within the sections by repo (IF there is >1 issue/PR for that repo in the list).

@levb @asaadmahmood Curious if you think it would help to present the summary in a tabular format (1 table per section)? Then the repo/org is more clearly visible.

something like (sorry, can't be bothered to get this markdown right - not rendering):
|Message | Org | Repo | Issue |
| --- | --- | --- | --- |
| Hey I think this thing could be positioned highe... | mattermost | mattermost-server | Issue 2938 |
| Not bad thinking but I need to think more about... | mattermost | jira-plugin | Issue 8 |

[levb]

-1 for tables, they consume too much space.

[checkaayush]

I'd like to take this up.

[levb]

@checkaayush go for it! A personal thank you if you get it done!

[checkaayush]

@levb In the suggested format [org/repo-last-token-ellipsis](repoURL)[PR/IssueID title](issueURL), if the title is going to be a hyperlink, isn't the PR/IssueID before it redundant?

I'd like to suggest the following:

• For unread messages:

  • [org/repo-last-token-ellipsis](repoURL) <type> [title](issueURL)
  • <type> above will be either PR or Issue
  • Example:
  • mattermost/...server Issue Rewrite existing plugin API tests to exclusively test via actual plugin

• For other categories:

  • [org/repo-last-token-ellipsis](repoURL) [title](issueURL)
  • Example:
  • mattermost/...server Rewrite existing plugin API tests to exclusively test via actual plugin

If we want overall consistency at the cost of some redundancy, we can even use the format picked for unread messages and apply it in all other categories.

Suggestions? @aaronrothschild

[levb]

@checkaayush I like your suggestion. It may be a good idea to post this for discussing in the Plugin: GitHub channel on community - I expect more opinions on the matter.

[aaronrothschild]

@checkaayush I like your suggestion. It may be a good idea to post this for discussing in the Plugin: GitHub channel on community - I expect more opinions on the matter.

@checkaayush Agree with Lev, I will take any developer suggestions over mine :)

[checkaayush]

I'm going ahead with development as per my suggestion here: https://github.com/mattermost/mattermost-plugin-github/issues/178#issuecomment-585133677. Have posted the suggested format on Plugin: GitHub channel for comments from the community.

I'll extract the message formatting logic in a separate function so that changing (and testing) it as desired becomes trivial.

[asaadmahmood]

I agree with @levb. Tables take too much space.

[checkaayush]

Assumptions I'm making during development:

• Trimming title to 80 characters with ellipsis as suffix.
• Repository names, when having multiple words, will be separated by hyphens -.

If any of the assumptions seem inappropriate, let me know.