Skip to content

chore: add metadata fields to package.json #864

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

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

MuhammadM1998
Copy link
Contributor

@MuhammadM1998 MuhammadM1998 commented Aug 15, 2024

πŸ”— Linked issue

N/A

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This adds 'description', 'homepage', 'repository' metadata fields to package.json to be used by e.g npm or renovate.

Screenshots of current behavior

npm: Open https://www.npmjs.com/package/@sidebase/nuxt-auth and you won't find 'Homepage' or 'Repository' as below
2

renovate: Notice other packages are clickable links and have 'source' which opens its repository, unlike @sidebase/nuxt-auth
1

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

Copy link
Collaborator

@phoenix-ru phoenix-ru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the catch and the fix - I actually bumped into it on NPM before and was surprised we don't do that.

@phoenix-ru phoenix-ru merged commit ebfa9c5 into sidebase:main Aug 15, 2024
5 checks passed
@MuhammadM1998 MuhammadM1998 deleted the patch-1 branch August 15, 2024 11:44
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.

2 participants