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

chore: update package description #11846

Merged
merged 7 commits into from
Jun 19, 2024
Merged

chore: update package description #11846

merged 7 commits into from
Jun 19, 2024

Conversation

hyunbinseo
Copy link
Contributor

Since SvelteKit is not mentioned in the package name, description, or tags, the kit package cannot be searched in npmjs.com with the SvelteKit keyword.

image


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Feb 14, 2024

🦋 Changeset detected

Latest commit: 0353fe2

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit 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

packages/kit/README.md Outdated Show resolved Hide resolved
benmccann and others added 3 commits February 24, 2024 08:00
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
@hyunbinseo
Copy link
Contributor Author

Other than the --open flag (which can be reverted if wished - maintainer editing is enabled)

- npm run dev
+ npm run dev -- --open

This PR is basically a one word change in the description. Could this be reviewed and merged?

- The fastest way to build Svelte apps
+ SvelteKit - the fastest way to build Svelte apps

packages/kit/README.md Outdated Show resolved Hide resolved
@benmccann
Copy link
Member

Thanks for the reminder and for pointing out this issue! I was just playing around with the search on npm and actually don't know if we should change the description either. I think keywords would be a better solution. If that alone isn't enough then maybe we can update the description. I sent #12330 as an attempt to fix this. I'll leave this open while we evaluate whether it's enough

@hyunbinseo
Copy link
Contributor Author

@sveltejs/kit is now searchable using the SvelteKit keyword.

image

@benmccann
Copy link
Member

great! too bad it's only the fourth result. I'll merge this to see if it helps boost it up the rankings

@benmccann benmccann merged commit 121836f into sveltejs:main Jun 19, 2024
9 of 12 checks passed
@github-actions github-actions bot mentioned this pull request Jun 19, 2024
@hyunbinseo hyunbinseo deleted the patch-3 branch June 19, 2024 03:16
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