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

README: Add note about npm install/yarn root #132

Closed
addyosmani opened this issue Jan 13, 2017 · 2 comments
Closed

README: Add note about npm install/yarn root #132

addyosmani opened this issue Jan 13, 2017 · 2 comments

Comments

@addyosmani
Copy link
Member

addyosmani commented Jan 13, 2017

Minor one. When you clone sw-helpers, it's not clear right now what the expectation would be when you npm install or yarn root.

One might guess this will recursively try installing all the dependencies for the sub-packages in the mono-repo. Or just the deps needed to hack on sw-helpers, but since we don't appear to note this in the readme it's unclear.

@addyosmani
Copy link
Member Author

Further feedback:

  • We should tell folks that they'll need to run gulp in order to build the packages
  • Might be useful to note whether you can individually build a subpackage and how (e.g do you need to build everything as they rely on each other as dependencies)

@gauntface
Copy link

@addyosmani I added this to the docs: https://googlechrome.github.io/sw-helpers/contributing.html#main

I think this addresses the above issues, let me know if not.

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

No branches or pull requests

2 participants