Skip to content

Commit ef99353

Browse files
committed
update CONTRIBUTING in regards with schema script
1 parent 6168306 commit ef99353

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,19 @@ Three additional helpers exist that are refreshed every second:
138138
There is also a search bar in the top right of the dashboard. This fuzzy-searches
139139
image mocks based on their file name and trace type.
140140

141-
#### Other npm scripts
141+
#### Step 5: Regenerate plot-schema in "test" folder then review & commit potential changes
142+
143+
```bash
144+
npm run schema
145+
```
146+
147+
#### Step 6: Review & commit potential changes made to test/plot-schema.json
148+
149+
> If you are editing attribute descriptions or implementing a new feature this file located in test folder would record the proposed changes to the API. This test file is different from the other plot-schema.json file located in the dist folder and should only be updated by maintainers at the release time.
150+
151+
**IMPORTANT:** please do not change and commit any files in the "dist" folder
152+
153+
#### Other npm scripts that may be of interest in development
142154

143155
- `npm run preprocess`: pre-processes the css and svg source file in js. This
144156
script must be run manually when updating the css and svg source files.

0 commit comments

Comments
 (0)