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

Update Link inline prop description #4127

Merged
merged 2 commits into from
Jan 9, 2024

Conversation

dipree
Copy link
Contributor

@dipree dipree commented Jan 8, 2024

https://github.com/github/primer/issues/2099

Updates the Link inline property description and set the underline property to "deprecated".

Copy link

changeset-bot bot commented Jan 8, 2024

🦋 Changeset detected

Latest commit: 9b53a27

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

github-actions bot commented Jan 8, 2024

size-limit report 📦

Path Size
dist/browser.esm.js 104.95 KB (0%)
dist/browser.umd.js 105.52 KB (0%)

@mperrotti mperrotti added the skip changeset This change does not need a changelog label Jan 9, 2024
@dipree dipree added this pull request to the merge queue Jan 9, 2024
Merged via the queue into main with commit c21b939 Jan 9, 2024
33 checks passed
@dipree dipree deleted the dipree/update-link-inline-prop-description branch January 9, 2024 17:49
@primer primer bot mentioned this pull request Jan 9, 2024
@joshblack
Copy link
Member

joshblack commented Jan 9, 2024

Just wanted to leave a couple notes for the deprecation process that I believe we're hoping to follow:

  • If possible, the deprecated item should have /** @deprecated */ as an annotation with a corresponding notice for what to use instead
  • The deprecated item should be marked as deprecated in the corresponding docs page
  • When a prop is deprecated, it would fall under a minor semver doc per the versioning guide
  • If possible, we should have a lint rule to manage deprecations (and offer fixes) over in: https://github.com/primer/eslint-plugin-primer-react

What would be a good place for us to include/document this info so that it's more apparent when making deprecation changes? Would that versioning guide be a good place? Just want to make sure we've captured all of these things so that things don't slip through the cracks 👀

Also, to coordinate messaging and what-not internally would it be helpful to have an issue template when deprecating items that include the checklist above plus any comms plan we would like to use to share the change with teams?

@dipree
Copy link
Contributor Author

dipree commented Jan 9, 2024

@joshblack what's the best to do now? Revert and merge again as minor with and additional note for "what to use instead" and adding a /** @deprecated */ here?

I had a quick look at this but then just looked at the options available and used the deprecated option.

dipree added a commit that referenced this pull request Jan 9, 2024
@dipree
Copy link
Contributor Author

dipree commented Jan 9, 2024

Revert: #4134
Follow-up: #4135

github-merge-queue bot pushed a commit that referenced this pull request Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants