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

Update contributing doc to better handle first run dpendency requirements #1645

Merged
merged 2 commits into from
Aug 22, 2018

Conversation

MitchellCash
Copy link
Contributor

The command yarn start is dependent on the npm-run-all package, therefore we can't recommend this as the first command someone runs after they just clone the repository in case they don't have it globally installed. Trying to yarn start without this package gets:

/bin/sh: run-s: command not found
error Command failed with exit code 127.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Therefore, on first setup it is recommended to run yarn bootstrap as the first command.

On a new system if a user was to run `yarn start` for the first time,
they would run into a dependency issue for missing the npm-run-all
package.

To get around this we must run `yarn bootstrap` on initial setup which
then allows us to run `yarn start` on subsequent runs.
@verythorough
Copy link
Contributor

Deploy preview for netlify-cms-www ready!

Built with commit 7788e09

https://deploy-preview-1645--netlify-cms-www.netlify.com

@verythorough
Copy link
Contributor

Deploy preview for cms-demo ready!

Built with commit 7788e09

https://deploy-preview-1645--cms-demo.netlify.com

@papandreou papandreou mentioned this pull request Aug 22, 2018
Copy link
Contributor

@tech4him1 tech4him1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, looks like that got broken, it was valid before npm-run-all was added. 😃 Thank you so much!

@verythorough verythorough merged commit a4ba66e into decaporg:master Aug 22, 2018
@MitchellCash MitchellCash deleted the contributing_doc branch August 22, 2018 22:43
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.

None yet

3 participants