Skip to content

Commit b993287

Browse files
committed
Updated README guidance.
1 parent 34a0059 commit b993287

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,16 @@ A collection of samples for Script Lab.
1616

1717
## Adding a new sample
1818

19-
1. Create a snippet using Script Lab.
20-
2. Click on `Copy to Clipboard` in the `Share` menu.
21-
3. Fill in the `author`, `name`, `description`, `source` properties if they are empty so that we can generate the playlist correctly.
19+
Adding a new sample can be done via the website... but if you want a variety of auto-completions to ensure that your snippet doesn't fail the build:
20+
1. Clone the samples repo. Run "npm install" (or "yarn install")
21+
2. Create a snippet using Script Lab. Ensure that the name and description are what you want them to be shown, publicly.
22+
3. Click on `Copy to Clipboard` in the `Share` menu.
2223
4. Add that snippet into the respective folders. Make sure that the snippet file names and folder names are in [`kebab-case`](http://wiki.c2.com/?KebabCase).
24+
5. Stage the change.
25+
6. Run `npm start`. If not everything succeeded, inspect the console output to check what validation is failing. Also check the pending changes relative to the staged version, as you may find that the script already substituted in required fields like `id` or `api_set` with reasonable defaults.
26+
7. Re-run `npm start` until the build succeeds.
27+
8. Submit to the repo.
28+
2329

2430
## Style guidelines:
2531

0 commit comments

Comments
 (0)