docs: fix outdated run instructions in CONTRIBUTING.md#717
Open
hariantara wants to merge 1 commit into
Open
Conversation
The project migrated to Astro (npm/pnpm), but CONTRIBUTING.md still told contributors to run `yarn install` and `yarn start`. There is no `start` script in package.json, so new contributors hit an error on their first run. Updated to use npm + the actual `dev` script and the correct Astro dev port (4321).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
CONTRIBUTING.mdstill instructs new contributors to runyarn installandyarn start, but the project has migrated to Astro and uses npm/pnpm.Why this is a problem
startscript inpackage.json(the scripts aredev,build,preview), soyarn startfails on a fresh clone — the first thing a new contributor tries.http://localhost:3000/, but Astro's dev server runs on 4321.Changes
yarn install→npm installyarn start→npm run devlocalhost:3000→localhost:4321This matches the current
package.jsonandREADME.md, so new contributors can get the project running on their first try.