Skip to content

Commit 6f66274

Browse files
committed
Update docs
1 parent c79c346 commit 6f66274

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,23 +171,30 @@ compliance, and so for strict builds we pre-generate regl shader code here.
171171
The CI pipeline will automatically detect when regl-related files have changed and
172172
run the codegen process. If the precompiled shaders are out of date, the
173173
`check-regl-codegen` job will fail and upload a `regl-codegen` artifact containing
174-
the updated files. To fix this:
174+
the updated files. The artifact represents the full desired state of the codegen
175+
output (CI wipes the output directory before regenerating, so any orphaned shader
176+
files are pruned). To fix this:
175177

176178
1. Download the `regl-codegen` artifact from the failed workflow run
177-
2. Copy the updated files into your working tree
179+
2. Delete `src/generated/regl-codegen/` in your working tree, then unzip the
180+
artifact at the repo root so it replaces (rather than merges into) the
181+
existing directory. Also overwrite the four `regl_precompiled.js` files
182+
under `src/traces/{scattergl,scatterpolargl,splom,parcoords}/`.
178183
3. Commit and push the changes to your pull request
179184

180-
Alternatively, you can regenerate the code locally by running:
185+
Alternatively, you can regenerate the code locally:
181186

182187
```bash
188+
rm -rf src/generated/regl-codegen/*
183189
npm run regl-codegen
184190
```
185191

186-
This will prompt you to open a browser window, run through all traces with 'regl'
187-
in the tags, and store the captured code into
192+
The `rm -rf` mirrors what CI does, so any orphaned shader files left over from
193+
previous changes get cleaned up. `npm run regl-codegen` will prompt you to open a
194+
browser window, run through all traces with 'regl' in the tags, and store the
195+
captured code into
188196
[src/generated/regl-codegen](https://github.com/plotly/plotly.js/blob/master/src/generated/regl-codegen).
189-
If no updates are necessary, it will be a no-op, but if there are changes, you
190-
will need to commit them.
197+
Commit any changes that result.
191198

192199
#### Other npm scripts that may be of interest in development
193200

0 commit comments

Comments
 (0)