docs: update CONTRIBUTING.md #2935
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
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. |
commit: |
|
| Playground | Link |
|---|---|
| React demo | https://livecodes.io?x=id/CM3TLJKDB |
See documentations for usage instructions.
|
I think we don't need to use |
|
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. |
|
Yeah, we didn't have one in valtio. |
Yeah, i saw valtio doesn't have it I'll update |
sukvvon
changed the title
|
Is it possible to have two sections for part 1 and part 2 more explicitly? Something like: # Contributing
## General Guideline
...
## Project-specific Guideline
...By this way, the review gets easier. The more we put guide in part 1, the better and easier to maintain. |
Co-authored-by: Daishi Kato <[email protected]>
CONTRIBUTING.md
Outdated
|
|
||
| 1. Install dependencies by running `pnpm install`. | ||
| 2. Create failing tests for your fix or new feature in the `tests` folder | ||
| 2. Create failing tests for your fix or new feature in the [`tests`](./tests/) folder. (e.g., `cd tests`) |
There was a problem hiding this comment.
I've never done cd tests. Do you do it?
There was a problem hiding this comment.
Create failing tests for your fix or new feature
The existing document already specifies performing tasks like the one mentioned above, and since the test path is also mentioned in the document, I added the cd tests command. Would you like me to remove the cd tests command?
There was a problem hiding this comment.
Yeah, I assume most devs open tests/* files from the project root.
There was a problem hiding this comment.
@dai-shi Yeah, so i added introducing about how to move tests folder from project root.
There was a problem hiding this comment.
Yeah, I assume most devs open
tests/*files from the project root.
Do you want to remove all of cd command part?
There was a problem hiding this comment.
All except for cd website as it's required to install node modules.
Co-authored-by: Daishi Kato <[email protected]>
Co-authored-by: Daishi Kato <[email protected]>
Co-authored-by: Daishi Kato <[email protected]>
Co-authored-by: Daishi Kato <[email protected]>
Co-authored-by: Daishi Kato <[email protected]>
Summary
CONTRIBUTING.mdCheck List
pnpm run fix:formatfor formatting code and docs