Skip to content

Commit c8c618c

Browse files
authored
Merge pull request #933 from pkbullock/main
Added new sample scaffolder skill
2 parents 232e8b1 + 546757e commit c8c618c

File tree

1 file changed

+30
-0
lines changed
  • .github/skills/sample-scaffolder

1 file changed

+30
-0
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: sample-scaffolder
3+
description: This skill is designed to take a skill that has been submitted as a PR and scaffold it into the sample format as an expected standard by the repository.
4+
---
5+
6+
# Sample Scaffolder Skill
7+
8+
This will wrap the scaffolding process for a skill that has been submitted as a PR. It will take the skill and scaffold it into the sample format as an expected standard by the repository.
9+
10+
## Expectations of the sample
11+
12+
- README.md file
13+
- assets folder with sample.json file
14+
- assets folder with a sample image
15+
16+
## Step by Step Workflow
17+
18+
There is a sample template folder called `scripts/_template-script-submission` that has the expected format for the sample.
19+
It contains
20+
- README.md file
21+
- assets folder with template.sample.json file
22+
- assets folder with a sample image
23+
24+
When running this skill it should be points in the folder in which the sample files are located e.g. script/my-sample/
25+
26+
This skill should
27+
28+
- If a readme.md file is not present, it should create one using the template readme.md file and fill in the relevant information from the skill submission.
29+
- Copy the template.sample.json file to the assets folder and rename it to sample.json. It should then fill in the relevant information from the skill submission into the sample.json file.
30+
- Copy the sample image to the assets folder.

0 commit comments

Comments
 (0)