octicons icon indicating copy to clipboard operation
octicons copied to clipboard

Rename some wrongly named icons

Open lukasoppermann opened this issue 1 year ago • 1 comments

We have other icons like circle and circle-slash. In Figma these icons are also called circle-check. It feels wrong to invert the naming logic for this one icon.

The alternative would be to go the other way and rename the remaining icons and all figma icons to [thing]-circle.

[!Warning] Warning: This is probably a breaking change. We could mitigate this by:

  1. Releasing the renamed and old icons in a minor update.
  2. Remove the badly named icons in a major release
  3. Search and replace all instances we find on github and primer.

lukasoppermann avatar May 02 '24 11:05 lukasoppermann

⚠️ No Changeset found

Latest commit: 327f703c7958ffe2f0ce76a13c5b6c520421670b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar May 02 '24 11:05 changeset-bot[bot]

Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days.

github-actions[bot] avatar Aug 11 '24 16:08 github-actions[bot]

@camertron, pinging you as I hope you can help.

We are currently in a tough spot, were renaming icons is nearly impossible, as we need to update the entire consuming project at the same time.

I think we need an approach that allows us to deprecate icons but keep them in package somehow.

Basically, having two versions of an icon, but one comes from a deprecated folder?

I don't know if we can log a console message for deprecated icons, e.g. `The icon "iconName-16" is deprecated, please use "newIconName-16" instead.

This would allow us to have both versions in the package at the same time, so that we can update the consumers and remove the icons in a next major. Any thoughts?

lukasoppermann avatar Nov 29 '24 08:11 lukasoppermann

Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days.

github-actions[bot] avatar Jan 28 '25 09:01 github-actions[bot]

@lukasoppermann hmm interesting...

Basically, having two versions of an icon, but one comes from a deprecated folder?

That should be possible, yes 👍

I don't know if we can log a console message for deprecated icons, e.g. `The icon "iconName-16" is deprecated, please use "newIconName-16" instead.

I'm not sure about React, but this is definitely possible for the Rails version of the octicons gem 😄

Will chat with @lesliecdubs about scoping and prioritizing this.

camertron avatar Jan 30 '25 18:01 camertron

@lukasoppermann do we know how critical this change is for consumers? How often do we hear confusion/trouble due to the wrong naming scheme?

I know we value consistency, but given that we'd need to scope and prioritize this against other pressing needs I'm interested to understand the demand for and impact of this change.

cc'ing @sunnyi101 as well, since it sounds like this might come down to a prioritization decision

lesliecdubs avatar Jan 30 '25 18:01 lesliecdubs