Skip to content

Restyle two tag-related features - #5416

Merged
fregante merged 4 commits into
mainfrom
improve-tag-styles
Mar 13, 2022
Merged

Restyle two tag-related features#5416
fregante merged 4 commits into
mainfrom
improve-tag-styles

Conversation

@kidonng

@kidonng kidonng commented Feb 16, 2022

Copy link
Copy Markdown
Member

First attempt: #5327

I made a mistake last time: the style is referenced from branch names, but tags are not actually branch names. This makes the blue background of branch names (in contrast to the usual gray of <code> blocks) less distinctive. The color also makes it appear more prominent than necessary, especially for tags-on-commits-list.

So this time I went to take a look at how release pages show the tag, which also shows meta info just like the feature does.

Screenshot

Test URL Before After
tags-on-commits-list
Multiple tags-on-commits-list
first-published-tag-for-merged-pr

Alternative design

Wrapping the version in <code>, which keeps it easily recognizable while being less prominent.

image

@cheap-glitch

Copy link
Copy Markdown
Contributor

I'd rather have a background under the tag name, it's usually short so it doesn't naturally stand out otherwise. I'm okay with either blue or gray.

@kidonng

kidonng commented Feb 16, 2022

Copy link
Copy Markdown
Member Author

I'd rather have a background under the tag name, it's usually short so it doesn't naturally stand out otherwise.

That's also one of the reason I had in the first attempt. However I think first-published-tag-for-merged-pr doesn't benefit that much from the background:

  • (As said above,) it makes branch names next to it less distinctive
  • With clean-conversation-headers there's really not much stuff there, so it can be easily spotted anyway

@kidonng
kidonng marked this pull request as draft February 16, 2022 13:38
@fregante

Copy link
Copy Markdown
Member

It kinda makes sense but really I think this piece of information is important enough to deserve visibility. For example in PRs it lets me know whether a PR has been released and in the commit list it acts as an instant "release notes" between versions.

Making it less visible I think lessens the impact of this feature, so its 👎 for me

@kidonng
kidonng marked this pull request as ready for review February 16, 2022 14:19
@kidonng

kidonng commented Feb 16, 2022

Copy link
Copy Markdown
Member Author

Making it less visible I think lessens the impact of this feature, so its 👎 for me

Alternative design then 😅

@fregante

Copy link
Copy Markdown
Member

I think the same applies, prominence is part of the feature IMHO, gray doesn't cut it.

@kidonng

kidonng commented Feb 28, 2022

Copy link
Copy Markdown
Member Author

the style is referenced from branch names, but tags are not actually branch names. This makes the blue background of branch names (in contrast to the usual gray of <code> blocks) less distinctive.

In short: the blue background is misleading. GitHub only uses that for branches, so should we.

The icon and the background already suggests some significance. Try out this PR and see if it really makes tags less to spot.

@fregante

fregante commented Mar 1, 2022

Copy link
Copy Markdown
Member

In short: the blue background is misleading. GitHub only uses that for branches, so should we.

I don’t think the color itself has any meaning for the user since this style only seems to appear in PRs headers, so claiming that it misleads the user is like saying all red cars look like Ferraris.

If you want to make a change to how first-published-tag-for-merged-pr looks I'd go in the opposite direction and make it even more noticeable somehow.

My arguments don't apply to tags-on-commits-list though so that part can be merged.

@kidonng

kidonng commented Mar 4, 2022

Copy link
Copy Markdown
Member Author

I don’t think the color itself has any meaning for the user since this style only seems to appear in PRs headers

That's not true, it is literally also in the timeline:

chrome_screenshot_1646379046423

And where linkify-branch-references apply:

These are just a few examples, I'm pretty sure there's more.

so claiming that it misleads the user is like saying all red cars look like Ferraris.

That style is from .commit-ref and it's called "commit ref" for a reason.

@cheap-glitch

Copy link
Copy Markdown
Contributor

I think it's fine to make small deviations from GitHub conventions when it makes sense. I agree with fregante that the highlight is part of the feature, it's small and when you're actively looking for it the color makes a difference — especially on cramped hi-def screens.

@fregante
fregante merged commit 31a1586 into main Mar 13, 2022
@fregante fregante changed the title Improve tags-on-commits-list and first-published-tag-for-merged-pr style (Second attempt) Restyle two tag-related features Mar 13, 2022
@fregante
fregante deleted the improve-tag-styles branch March 13, 2022 13:17
@fregante

Copy link
Copy Markdown
Member

Let's try

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

3 participants