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

docs: add homepage link in each project package.json #88

Merged
merged 1 commit into from
May 29, 2020

Conversation

blittle
Copy link
Contributor

@blittle blittle commented May 28, 2020

This is important because it improves the UX on npmjs.org with a link
back to the git repository.

@blittle
Copy link
Contributor Author

blittle commented May 28, 2020

It might be worth considering adding appropriate package.json properties for repository and bugs. Then the question is, what should the link be for homepage vs repository? Should homepage for all LWC projects point to https://lwc.dev/?

For comparison:

React - https://unpkg.com/react@16.13.1/package.json
React DOM (another project in their monorepo): https://unpkg.com/react-dom@16.13.1/package.json
Vue - https://unpkg.com/vue@2.6.11/package.json

@pmdartus
Copy link
Member

I vote for the homepage pointing to https://lwc.dev since it includes the guide for jest setup and the repository pointing to https://github.com/salesforce/lwc-test.

@trevor-bliss
Copy link
Contributor

Yes, +1 to what Pierre-Marie suggested.

@blittle
Copy link
Contributor Author

blittle commented May 28, 2020

@pmdartus would you prefer a link to the repo, or a link to the module within the monorepo? https://github.com/salesforce/lwc-test vs https://github.com/salesforce/lwc-test/tree/master/packages/%40lwc/jest-preset

@blittle
Copy link
Contributor Author

blittle commented May 28, 2020

NM, I think we should do what react does, just link to the repo but have a directory reference for the module: https://unpkg.com/react@16.13.1/package.json

This is important because it improves the UX on npmjs.org with a link
back to the git repository and lwc homepage.
Copy link
Member

@ekashida ekashida 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!

@ekashida ekashida merged commit 40df13b into salesforce:master May 29, 2020
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.

4 participants