You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing.md
+27-29Lines changed: 27 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,6 @@ Thank you for your interest in contributing to theme-tools! Your contributions w
5
5
## Table of Contents
6
6
7
7
-[Setting Up Your Environment](#setting-up-your-environment)
8
-
-[Setup for the VS Code Extension](#setup-for-the-vscode-extension)
9
-
-[Setup for the Online Store](#setup-for-the-online-store)
10
8
-[Submitting a Pull Request](#submitting-a-pull-request)
11
9
-[Reporting Issues](#reporting-issues)
12
10
-[Code of Conduct](#code-of-conduct)
@@ -39,10 +37,10 @@ Before you can start contributing to theme-tools, you'll need to set up your dev
39
37
```bash
40
38
yarn test
41
39
```
40
+
42
41
5.**Start developing**: If you're developing changes to test against the vscode extension, all you need to do is add a breakpoint anywhere in a package used within the VS Code extension, hit `f5` in VS Code and your development instance of theme-check will automatically open.
43
42
44
-
### Developing for online-store-web
45
-
It is strongly recommended that you use the spin constellation: `theme-tools:online-store` as your development environment for this.
43
+
### Developing for online-store-web (Shopifolk only)
46
44
47
45
To set up the package links to online-store-web, within this repo root run: `yarn admin:init`
48
46
@@ -54,7 +52,7 @@ Once you've made some changes to your local theme-tools packages, to see those c
54
52
55
53
Run the following command to start a browser instance that runs `@shopify/theme-language-server-browser`.
56
54
57
-
```
55
+
```bash
58
56
yarn playground
59
57
```
60
58
@@ -80,45 +78,45 @@ If ever you want to see how the VS Code extension or playground would behave bef
80
78
81
79
1. In a terminal, with VS Code closed, go to the Shopify/theme-liquid-docs directory.
82
80
83
-
```sh
84
-
# Shopifolk
85
-
dev cd theme-liquid-docs
81
+
```sh
82
+
# Shopifolk
83
+
dev cd theme-liquid-docs
86
84
87
-
# External
88
-
cd /path/to/theme-liquid-docs
89
-
```
85
+
# External
86
+
cd /path/to/theme-liquid-docs
87
+
```
90
88
91
89
2. Export the root of that repository in the `SHOPIFY_TLD_ROOT` environment variable
92
90
93
-
```sh
94
-
export SHOPIFY_TLD_ROOT=$(pwd)
95
-
```
91
+
```sh
92
+
export SHOPIFY_TLD_ROOT=$(pwd)
93
+
```
96
94
97
95
3. Go to the Shopify/theme-tools directory.
98
96
99
-
```sh
100
-
# Shopifolk
101
-
dev cd theme-tools
97
+
```sh
98
+
# Shopifolk
99
+
dev cd theme-tools
102
100
103
-
# External
104
-
cd /path/to/theme-tools
105
-
```
101
+
# External
102
+
cd /path/to/theme-tools
103
+
```
106
104
107
105
4. Update the docs and start VS Code from that directory.
108
106
109
-
```sh
110
-
# update the docs
111
-
theme-docs download
107
+
```sh
108
+
# update the docs
109
+
theme-docs download
112
110
113
-
# start vscode
114
-
code .
115
-
```
111
+
# start vscode
112
+
code .
113
+
```
116
114
117
115
5. (Repeat) You can repeat the `theme-docs download` command to have updated changes.
118
116
119
-
```sh
120
-
theme-docs download
121
-
```
117
+
```sh
118
+
theme-docs download
119
+
```
122
120
123
121
6. Proceed to debug the VS Code extension or playground as usual.
0 commit comments