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(CONTRIBUTING.md): clarify used scripts #2935

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Jan 15, 2025

Summary

  • Change pnpm run prettier to pnpm run fix:format
  • Change pnpm dev to pnpm run dev for consistency and avoiding alias

Check List

  • pnpm run fix:format for formatting code and docs

Copy link

vercel bot commented Jan 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jotai ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 4:46am

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Copy link

pkg-pr-new bot commented Jan 15, 2025

Open in Stackblitz

More templates

npm i https://pkg.pr.new/jotai@2935

commit: 1a275f2

Copy link

LiveCodes Preview in LiveCodes

Latest commit: 1a275f2
Last updated: Jan 15, 2025 4:45am (UTC)

Playground Link
React demo https://livecodes.io?x=id/HM3RA24QQ

See documentations for usage instructions.

@sukvvon
Copy link
Contributor Author

sukvvon commented Jan 15, 2025

@dai-shi

I think we don't need to use yalc and it's fine only using pnpm link, because before use yalc, we need to install it.
Would you want to use yalc?

@dai-shi
Copy link
Member

dai-shi commented Jan 15, 2025

Thanks for opening up the suggestion.

CONTRIBUTING.md isn't well maintained across three repos. So, it's a good chance to overhaul it.

Let's have two parts. The first part is common part that is same for all zustand/jotai/valtio. The second part is specific to each lib.

What would be your suggestion if you were to write it from scratch?

@sukvvon
Copy link
Contributor Author

sukvvon commented Jan 15, 2025

@dai-shi

Thanks for opening up the suggestion.

CONTRIBUTING.md isn't well maintained across three repos. So, it's a good chance to overhaul it.

Let's have two parts. The first part is common part that is same for all zustand/jotai/valtio. The second part is specific to each lib.

What would be your suggestion if you were to write it from scratch?

The first part sounds good. I think we can combine the best practices of both zustand and jotai. I believe it’s important to keep it concise and clear when writing.

@dai-shi
Copy link
Member

dai-shi commented Jan 15, 2025

Yeah, we didn't have one in valtio.

@sukvvon
Copy link
Contributor Author

sukvvon commented Jan 15, 2025

@dai-shi

Yeah, we didn't have one in valtio.

Yeah, i saw valtio doesn't have it

I'll update CONTRIBUTING.md with the combined zustand and jotai in this PR, then i'll create the same PR in valtio and zustand

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