create-agent-skills 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -80,25 +80,65 @@ mkdir -p .agent/skills/<skill-name>/examples
|
|
|
80
80
|
mkdir -p .agent/skills/<skill-name>/resources
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
##
|
|
83
|
+
## Managing Long Skills
|
|
84
|
+
|
|
85
|
+
> [!WARNING]
|
|
86
|
+
> **SKILL.md MUST NOT exceed 500 lines.** If your skill is getting too long, you MUST split content into external files.
|
|
87
|
+
|
|
88
|
+
### File Length Rules
|
|
89
|
+
|
|
90
|
+
| SKILL.md Length | Action Required |
|
|
91
|
+
|-----------------|-----------------|
|
|
92
|
+
| < 300 lines | ✅ OK - Keep everything in SKILL.md |
|
|
93
|
+
| 300-500 lines | ⚠️ Consider splitting large examples |
|
|
94
|
+
| > 500 lines | ❌ MUST split into external files |
|
|
95
|
+
|
|
96
|
+
### How to Split Long Skills
|
|
97
|
+
|
|
98
|
+
1. **Move examples to `examples/` folder**
|
|
99
|
+
```bash
|
|
100
|
+
mkdir -p .agent/skills/<skill-name>/examples
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
2. **Move reference docs to `resources/` folder**
|
|
104
|
+
```bash
|
|
105
|
+
mkdir -p .agent/skills/<skill-name>/resources
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
3. **Keep SKILL.md focused on:**
|
|
109
|
+
- Overview and when to use
|
|
110
|
+
- Quick start / essential commands
|
|
111
|
+
- Links to detailed examples
|
|
112
|
+
- Best practices summary
|
|
113
|
+
|
|
114
|
+
4. **Link external files in SKILL.md:**
|
|
115
|
+
```markdown
|
|
116
|
+
## Examples & Resources
|
|
117
|
+
|
|
118
|
+
### Examples
|
|
119
|
+
- [Basic Usage](examples/basic-usage.md) - Getting started example
|
|
120
|
+
- [Advanced Patterns](examples/advanced-patterns.md) - Complex use cases
|
|
121
|
+
|
|
122
|
+
### Resources
|
|
123
|
+
- [Commands Reference](resources/commands-reference.md) - Full command list
|
|
124
|
+
- [Configuration Guide](resources/configuration.md) - All config options
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### What Goes Where
|
|
128
|
+
|
|
129
|
+
| Content Type | Location | Max Size |
|
|
130
|
+
|--------------|----------|----------|
|
|
131
|
+
| Overview, when to use | `SKILL.md` | - |
|
|
132
|
+
| Quick examples (< 50 lines) | `SKILL.md` | 50 lines each |
|
|
133
|
+
| Long examples (> 50 lines) | `examples/*.md` | No limit |
|
|
134
|
+
| Full API/command reference | `resources/*.md` | No limit |
|
|
135
|
+
| Helper scripts | `scripts/*.js` | No limit |
|
|
136
|
+
| Templates, configs | `resources/*` | No limit |
|
|
137
|
+
|
|
138
|
+
### Links Requirement
|
|
84
139
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
| Folder | Use For |
|
|
88
|
-
|--------|---------|
|
|
89
|
-
| `examples/` | Complete, runnable code examples |
|
|
90
|
-
| `scripts/` | Helper scripts the agent should run |
|
|
91
|
-
| `resources/` | Templates, config files, assets |
|
|
92
|
-
|
|
93
|
-
Link to external files using relative paths:
|
|
94
|
-
|
|
95
|
-
```markdown
|
|
96
|
-
## Examples
|
|
97
|
-
|
|
98
|
-
See complete examples:
|
|
99
|
-
- [Basic Usage](./examples/basic-usage.js)
|
|
100
|
-
- [Advanced Patterns](./examples/advanced-patterns.js)
|
|
101
|
-
```
|
|
140
|
+
> [!IMPORTANT]
|
|
141
|
+
> Every file in `examples/`, `scripts/`, and `resources/` folders **MUST be linked** in SKILL.md. Unlinked files will not be discovered by the agent.
|
|
102
142
|
|
|
103
143
|
## SKILL.md Template
|
|
104
144
|
|
|
@@ -63,6 +63,51 @@ Before committing, ask yourself:
|
|
|
63
63
|
| `ci` | 👷 CI configuration | `ci: add GitHub Actions` |
|
|
64
64
|
| `chore` | ♻️ Other maintenance | `chore: update .gitignore` |
|
|
65
65
|
|
|
66
|
+
## Optional: Emoji Prefix Format
|
|
67
|
+
|
|
68
|
+
You can optionally prefix commit messages with emojis for better visual scanning:
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
<icon> <type>(<scope>): <subject>
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Format Examples
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# With emoji prefix
|
|
78
|
+
🐛 fix(api): handle null response
|
|
79
|
+
✨ feat(auth): add OAuth login
|
|
80
|
+
📚 docs: update installation guide
|
|
81
|
+
🔧 refactor(utils): simplify validation logic
|
|
82
|
+
🚀 perf(query): optimize database queries
|
|
83
|
+
|
|
84
|
+
# Standard format (also valid)
|
|
85
|
+
fix(api): handle null response
|
|
86
|
+
feat(auth): add OAuth login
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Type to Emoji Mapping
|
|
90
|
+
|
|
91
|
+
| Type | Emoji | Unicode |
|
|
92
|
+
|------|-------|---------|
|
|
93
|
+
| `feat` | ✨ | `:sparkles:` |
|
|
94
|
+
| `fix` | 🐛 | `:bug:` |
|
|
95
|
+
| `docs` | 📚 | `:books:` |
|
|
96
|
+
| `style` | 🎨 | `:art:` |
|
|
97
|
+
| `refactor` | 🔧 | `:wrench:` |
|
|
98
|
+
| `perf` | 🚀 | `:rocket:` |
|
|
99
|
+
| `test` | 🧪 | `:test_tube:` |
|
|
100
|
+
| `build` | 📦 | `:package:` |
|
|
101
|
+
| `ci` | 👷 | `:construction_worker:` |
|
|
102
|
+
| `chore` | ♻️ | `:recycle:` |
|
|
103
|
+
| `revert` | ⏪ | `:rewind:` |
|
|
104
|
+
| `hotfix` | 🚑 | `:ambulance:` |
|
|
105
|
+
| `security` | 🔒 | `:lock:` |
|
|
106
|
+
| `wip` | 🚧 | `:construction:` |
|
|
107
|
+
|
|
108
|
+
> [!TIP]
|
|
109
|
+
> Using emojis is **optional** and depends on team preference. Both formats are valid. The emoji helps quickly identify commit types when scanning git log.
|
|
110
|
+
|
|
66
111
|
## Subject Line Rules
|
|
67
112
|
|
|
68
113
|
1. **Use imperative mood**: "add" not "added" or "adds"
|