Skip to content

Commit 8fbcf15

Browse files
committed
updated CONTRIBUTING with instructions for npm run regl-codegen
1 parent ebd90d5 commit 8fbcf15

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,23 @@ npm run schema
162162
163163
**IMPORTANT:** please do not change and commit any files in the "dist" folder
164164

165+
#### Step 9: REGL - Review & commit potential changes to precompiled regl shaders
166+
167+
If you are implementing a new feature that involves regl shaders, or if you are
168+
making changes that affect the usage of regl shaders, you would need to run
169+
170+
```bash
171+
npm run regl-codegen
172+
```
173+
174+
to regenerate the regl code. This opens a browser window, runs through all
175+
traces with 'regl' in the tags, and stores the captured code into
176+
src/generated/regl-codegen. If no updates are necessary, it would be a no-op, but
177+
if there are changes, you would need to commit them.
178+
179+
This is needed because regl performs codegen in runtime which breaks CSP
180+
compliance, and so for strict builds we pre-compile regl codegen now.
181+
165182
#### Other npm scripts that may be of interest in development
166183

167184
- `npm run preprocess`: pre-processes the css and svg source file in js. This

0 commit comments

Comments
 (0)