Improving the contributing docs #1114
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/pikapkg/snowpack/7j1ed07cz |
CONTRIBUTING.md
Outdated
| @@ -65,6 +92,14 @@ cd path/to/some-other-project | |||
| snowpack dev --verbose --reload | |||
| ``` | |||
|
|
|||
| To test a local version of the `create-snowpack-app` templates use | |||
|
|
|||
| NOTE This does not work, trying to figure this one out | |||
There was a problem hiding this comment.
one thing that could help: splitting this into two different snippets:
To test CLI changes: node /path/to/snowpack/create-snowpack-app/cli [my-new-dir] --template @snowpack/app-template-vue
To test a new template: npx create-snowpack-app [my-new-dir] --template /path/to/template
There was a problem hiding this comment.
good idea 👍🏼
Let me know if I can help @melissamcewen
There was a problem hiding this comment.
I still get [ERROR] Unable to find "/Users/melissamcewen/sites/snowpack/create-snowpack-app/app-template-vue" in the npm registry. with either
CONTRIBUTING.md
Outdated
| @@ -65,6 +92,14 @@ cd path/to/some-other-project | |||
| snowpack dev --verbose --reload | |||
| ``` | |||
|
|
|||
| To test a local version of the `create-snowpack-app` templates use | |||
|
|
|||
| NOTE This does not work, trying to figure this one out | |||
There was a problem hiding this comment.
good idea 👍🏼
Let me know if I can help @melissamcewen
Changes
I encountered a few snags when trying to update the Vue template and I thought I'd take a shot at addressing them in the docs.
Testing
Docs only