summaryrefslogtreecommitdiff
path: root/tools/astro-vscode/contributing.md
diff options
context:
space:
mode:
authorGravatar Matthew Phillips <matthew@matthewphillips.info> 2021-05-08 11:35:20 -0400
committerGravatar GitHub <noreply@github.com> 2021-05-08 11:35:20 -0400
commit60e482aa809fd89c865bfb5ec95b97a739235615 (patch)
tree559f2d84d98b833712ad7ca969d0ba7ae2e1f506 /tools/astro-vscode/contributing.md
parentb4c072d1a13902c90294bebf320fd1cb9550ba0e (diff)
downloadastro-60e482aa809fd89c865bfb5ec95b97a739235615.tar.gz
astro-60e482aa809fd89c865bfb5ec95b97a739235615.tar.zst
astro-60e482aa809fd89c865bfb5ec95b97a739235615.zip
Fix running the extension (#181)
I'm not sure how my setup was different but I was unable to get the extension to run locally without adding a binary. This mirrors what Svelte does so I'm assuming it's the way it's supposed to be loaded.
Diffstat (limited to '')
-rw-r--r--tools/astro-vscode/contributing.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/tools/astro-vscode/contributing.md b/tools/astro-vscode/contributing.md
new file mode 100644
index 000000000..d9f1bd59e
--- /dev/null
+++ b/tools/astro-vscode/contributing.md
@@ -0,0 +1,20 @@
+# Contributing
+
+## Development workflow
+
+In the monorepo first install and build Astro:
+
+```shell
+yarn install
+yarn build
+```
+
+To start the development server run:
+
+```shell
+yarn dev:vscode
+```
+
+Then in the __Debug__ panel select __Launch Extension__ from the dropdown and click the run button.
+
+<img width="558" alt="Screen Shot 2021-05-07 at 8 51 37 AM" src="https://user-images.githubusercontent.com/361671/117452223-807e5580-af11-11eb-8404-dd615784408a.png">