docs: add steps for quickly getting started for local dev #166
Conversation
This file contains 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
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.
Just wanted a small section (near the top) to make it easy to figure out how to get started for local development. I like most devs can figure this out but this helps very quickly all the steps necessary so there's no confusion.
Preview here: https://github.com/patricknelson/makeup-js/blob/docs-local-dev/CONTRIBUTING.md#getting-started-for-local-development
Why: There are a lot of commands there. At first, I stumbled on this since I manually ran
npm run serverandnpm run watchin separate windows until I realizednpm run startexisted (which also performed an initial build as well, which I was missing).Also, quick nit: I changed "HTMLElement Modules" to "Custom Elements" to align with more common use of the term. Also, saying "a.k.a. Web components" is fine IMHO since, while custom elements are a subset of the broader suite of web component standards, I think the custom elements API is a core part of that (shadow DOM, slots and templates are all optional).