mattermost-plugin-github icon indicating copy to clipboard operation
mattermost-plugin-github copied to clipboard

Published 20 hours ago • verified publisher icon mattermost

Implement tooltip content for more types of GitHub links

Open mickmister opened this issue 2 years ago • 10 comments

At the moment, we show a tooltip for issues and PRs. We can also show the tooltip for the following entities:

  • repos
  • branches
  • commits
  • files

The task here is to modify the Link Tooltip component to support showing a tooltip card for the entities listed above.

image

mickmister avatar Nov 15 '22 06:11 mickmister

@mickmister What should we show in the tooltip for branches and files ?

Nityanand13 avatar Dec 27 '22 13:12 Nityanand13

@mickmister What is your suggestion for repos and commits? As of now for repos we have added:

  • Description
  • Stars
  • Watching
  • Forks
  • Branches
  • Tags

TooltipForRepo

and for commit we have added:

  • Message

TooltipForCommit

Nityanand13 avatar Jan 02 '23 15:01 Nityanand13

@matthewbirtch What do you think?

hanzei avatar Jan 03 '23 17:01 hanzei

@Nityanand13 For the repo view, I'm thinking a small preview of the README would be more beneficial than seeing the stats.

@mickmister What should we show in the tooltip for branches and files ?

I think the branch view can be the same as repo view. The file view could have a small preview of the first few lines of a file.

mickmister avatar Jan 03 '23 19:01 mickmister

@mickmister For the repo, a small preview of README is enough or can we add stats along with that?

Nityanand13 avatar Jan 05 '23 13:01 Nityanand13

@mickmister Is there any modification needed for the tooltip of a file?

fileTooltip

Nityanand13 avatar Jan 05 '23 14:01 Nityanand13

@matthewbirtch What do you think?

The suggestions here are decent suggestions. Should we queue this up for someone on the UX team to design something for each of these scenarios outlined before implementing or opening up for Help wanted? I know we don't have a truly dedicated UX designer for the integrations team right now, but I'm sure we can get someone to work on it.

matthewbirtch avatar Jan 06 '23 21:01 matthewbirtch

Should we queue this up for someone on the UX team to design something for each of these scenarios outlined before implementing or opening up for Help wanted?

@matthewbirtch That sounds good to me :+1: How do you suggest I do this? Should I file a ticket in Jira, and assign to UX with fix version triage?

The file view could have a small preview of the first few lines of a file.

Note that if it's a permalink URL to a specific line/range of lines, the preview should keep those lines in mind

mickmister avatar Jan 06 '23 21:01 mickmister

@matthewbirtch That sounds good to me 👍 How do you suggest I do this? Should I file a ticket in Jira, and assign to UX with fix version triage?

That is fine @mickmister and we can triage it from there. FYI, we will likely be changing this process in the future, to keep it on the team that will be implementing with a ux-needed label and PMs can prioritize with UX, but for now, we can triage it easiest the way you've mentioned above.

matthewbirtch avatar Jan 09 '23 15:01 matthewbirtch

@wiggin77 Do you think we should start working on this issue or make this as help wanted. As this is quite a big task. We have to support multiple types of tooltips. I have shared you the figma link for designs in your DM on hub.

raghavaggarwal2308 avatar Jul 11 '24 08:07 raghavaggarwal2308