aidenybai / million

Optimize React performance and make your React 70% faster in minutes, not months.
https://million.dev
MIT License
16.19k stars 567 forks source link

📝 Docs: Suggested `pnpm run dev` command doesn't exist in root or packages? #864

Closed JoshuaKGoldberg closed 8 months ago

JoshuaKGoldberg commented 8 months ago

When I tried going through this part of the contributing guide:

https://github.com/aidenybai/million/blob/d8b5c212ea41e1f811a25376a75ae224515d9324/.github/CONTRIBUTING.md#L112-L117

Running pnpm run dev the root directory gives:

joshgoldberg ~/repos/million $ pnpm run dev
 ERR_PNPM_NO_SCRIPT  Missing script: dev

Same result for the packages/ directory:

joshgoldberg ~/repos/million/packages $ pnpm run dev
 ERR_PNPM_NO_SCRIPT  Missing script: dev

Should dev be replaced with build or some other command? Note that pnpm run dev does exist in website/package.json - just not package.json.

Also, I don't think it's clear from the docs whether that command should be run in the root directory or packages/. It'd be nice to clarify.

Great contributing guide otherwise btw! 🙌

github-actions[bot] commented 8 months ago

Thanks for opening this issue! A maintainer will review it soon.

tobySolutions commented 8 months ago

When I tried going through this part of the contributing guide:

https://github.com/aidenybai/million/blob/d8b5c212ea41e1f811a25376a75ae224515d9324/.github/CONTRIBUTING.md#L112-L117

Running pnpm run dev the root directory gives:

joshgoldberg ~/repos/million $ pnpm run dev
 ERR_PNPM_NO_SCRIPT  Missing script: dev

Same result for the packages/ directory:

joshgoldberg ~/repos/million/packages $ pnpm run dev
 ERR_PNPM_NO_SCRIPT  Missing script: dev

Should dev be replaced with build or some other command? Note that pnpm run dev does exist in website/package.json - just not package.json.

Also, I don't think it's clear from the docs whether that command should be run in the root directory or packages/. It'd be nice to clarify.

Great contributing guide otherwise btw! 🙌

😁 😁 , thanks @JoshuaKGoldberg!