|
1 | | -# Pull Request |
2 | | - |
3 | | -## Description |
4 | | - |
5 | | -<!-- Please provide a brief description of the changes in this PR --> |
6 | | - |
7 | | -## Type of Change |
8 | | - |
9 | | -- [ ] New sample onboarding (internal - source code in this repo) |
10 | | -- [ ] New sample onboarding (external - source code in another repo) |
11 | | -- [ ] Sample update/fix |
12 | | -- [ ] Documentation update |
13 | | -- [ ] Validation tool update |
14 | | -- [ ] Other (please describe) |
15 | | - |
16 | | ---- |
17 | | - |
18 | | -## For New Sample Onboarding |
19 | | - |
20 | | -### Checklist |
21 | | - |
22 | | -- [ ] I have added/updated the sample entry in `.config/samples-config-v3.json` |
23 | | -- [ ] I have included a README.md with setup instructions |
24 | | -- [ ] I have included a thumbnail image with correct aspect ratio (40:23, e.g., 1600×920 or 800×460) |
25 | | - |
26 | | -### Validation Results (Required) |
27 | | - |
28 | | -> **Important**: You must run the validation tool locally and provide a screenshot of the results. |
29 | | -
|
30 | | -#### For Internal Samples (source code in this repo) |
31 | | - |
32 | | -```bash |
33 | | -cd validation-tool |
34 | | -npm install |
35 | | -node validator.cjs -p ../<your-sample-folder> |
36 | | -``` |
37 | | - |
38 | | -#### For External Samples (source code in another repo) |
39 | | - |
40 | | -```bash |
41 | | -cd validation-tool |
42 | | -npm install |
43 | | - |
44 | | -# Clone your sample repo (sparse checkout recommended) |
45 | | -git clone --filter=blob:none --sparse <your-repo-url> |
46 | | -cd <repo-name> |
47 | | -git sparse-checkout set <path-to-sample> |
48 | | -cd .. |
49 | | - |
50 | | -# Run validation |
51 | | -node validate-external.js <sample-id> ./<repo-name> |
52 | | -``` |
53 | | - |
54 | | - |
55 | | ---- |
56 | | - |
57 | | -## Related Issues |
58 | | - |
59 | | -<!-- Link any related issues here, e.g., "Fixes #123" or "Related to #456" --> |
60 | | -if any question related to validation, may refer to the [Sample Validation Guide](validation-tool/sample_validation.md) |
61 | | -if still has questions, may open a issue :) |
| 1 | +# Pull Request |
| 2 | + |
| 3 | +## Description |
| 4 | + |
| 5 | +<!-- Please provide a brief description of the changes in this PR --> |
| 6 | + |
| 7 | +## Type of Change |
| 8 | + |
| 9 | +- [ ] New sample onboarding (internal - source code in this repo) |
| 10 | +- [ ] New sample onboarding (external - source code in another repo) |
| 11 | +- [ ] Sample update/fix |
| 12 | +- [ ] Documentation update |
| 13 | +- [ ] Validation tool update |
| 14 | +- [ ] Other (please describe) |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## For New Sample Onboarding |
| 19 | + |
| 20 | +### Checklist |
| 21 | + |
| 22 | +- [ ] I have added/updated the sample entry in `.config/samples-config-v3.json` |
| 23 | +- [ ] I have included a README.md with setup instructions |
| 24 | +- [ ] I have included a thumbnail image with correct aspect ratio (40:23, e.g., 1600×920 or 800×460) |
| 25 | + |
| 26 | +### Validation Results (Required) |
| 27 | + |
| 28 | +> **Important**: You must run the validation tool locally and provide a screenshot of the results. |
| 29 | +
|
| 30 | +#### For Internal Samples (source code in this repo) |
| 31 | + |
| 32 | +```bash |
| 33 | +cd validation-tool |
| 34 | +npm install |
| 35 | +node validator.mjs -p ../<your-sample-folder> |
| 36 | +``` |
| 37 | + |
| 38 | +#### For External Samples (source code in another repo) |
| 39 | + |
| 40 | +```bash |
| 41 | +cd validation-tool |
| 42 | +npm install |
| 43 | + |
| 44 | +# Clone your sample repo (sparse checkout recommended) |
| 45 | +git clone --filter=blob:none --sparse <your-repo-url> |
| 46 | +cd <repo-name> |
| 47 | +git sparse-checkout set <path-to-sample> |
| 48 | +cd .. |
| 49 | + |
| 50 | +# Run validation |
| 51 | +node validate-external.js <sample-id> ./<repo-name> |
| 52 | +``` |
| 53 | + |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## Related Issues |
| 58 | + |
| 59 | +<!-- Link any related issues here, e.g., "Fixes #123" or "Related to #456" --> |
| 60 | +if any question related to validation, may refer to the [Sample Validation Guide](validation-tool/sample_validation.md) |
| 61 | +if still has questions, may open a issue :) |
0 commit comments