Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename some wrongly named icons #1023

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

lukasoppermann
Copy link
Contributor

@lukasoppermann lukasoppermann commented May 2, 2024

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.

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.
@lukasoppermann lukasoppermann requested a review from a team as a code owner May 2, 2024 11:26
Copy link

changeset-bot bot commented May 2, 2024

⚠️ No Changeset found

Latest commit: 327f703

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

@lukasoppermann lukasoppermann changed the title Rename check-circle-16.svg to circle-check-16.svg Rename some wrongly named icons May 2, 2024
Copy link
Contributor

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 github-actions bot added the Stale label Aug 11, 2024
@github-actions github-actions bot closed this Aug 18, 2024
@github-actions github-actions bot deleted the lukasoppermann-rename-icons-check-circle branch August 18, 2024 17:02
@lukasoppermann lukasoppermann restored the lukasoppermann-rename-icons-check-circle branch November 18, 2024 14:01
@github-actions github-actions bot closed this Nov 25, 2024
@github-actions github-actions bot deleted the lukasoppermann-rename-icons-check-circle branch November 25, 2024 16:03
@lukasoppermann lukasoppermann restored the lukasoppermann-rename-icons-check-circle branch November 29, 2024 08:01
@lukasoppermann
Copy link
Contributor Author

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants