@groupby/ai-dev 0.2.0 → 0.2.3
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/README.md +3 -1
- package/dist/index.js +86 -19
- package/package.json +3 -3
- package/toolsets/rzlv-flow/README.md +54 -9
- package/toolsets/rzlv-flow/resources/confluence-file-structure.md +129 -23
- package/toolsets/rzlv-flow/resources/sync-state-format.md +109 -0
- package/toolsets/rzlv-flow/skills/jira-daily-triage/SKILL.md +13 -5
- package/toolsets/rzlv-flow/skills/jira-sprint-status/SKILL.md +28 -1
- package/toolsets/rzlv-flow/skills/jira-ticket-focus/SKILL.md +6 -1
- package/toolsets/rzlv-flow/skills/jira-wrap-sync/SKILL.md +41 -8
- package/skills/skills/README.md +0 -61
- package/skills/skills/archived/README.md +0 -3
- package/skills/skills/library/README.md +0 -3
- package/skills/skills/library/frontend-design/LICENSE.txt +0 -177
- package/skills/skills/library/frontend-design/SKILL.md +0 -42
- package/teams/teams/brain-studio/skills/code-review/SKILL.md +0 -46
- package/toolsets/toolsets/rzlv-flow/README.md +0 -102
- package/toolsets/toolsets/rzlv-flow/docs/mcp-setup.md +0 -126
- package/toolsets/toolsets/rzlv-flow/resources/README.md +0 -16
- package/toolsets/toolsets/rzlv-flow/resources/confluence-file-structure.md +0 -285
- package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/README.md +0 -19
- package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/decisions.md +0 -36
- package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/initiative-overview.md +0 -40
- package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/strategic-context.md +0 -44
- package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/technical-architecture.md +0 -48
- package/toolsets/toolsets/rzlv-flow/resources/fcmp-protocol.md +0 -331
- package/toolsets/toolsets/rzlv-flow/resources/jira-file-structure.md +0 -177
- package/toolsets/toolsets/rzlv-flow/resources/sync-state-format.md +0 -318
- package/toolsets/toolsets/rzlv-flow/skills/atlassian-orchestrator/SKILL.md +0 -643
- package/toolsets/toolsets/rzlv-flow/skills/context-analyst/SKILL.md +0 -265
- package/toolsets/toolsets/rzlv-flow/skills/jira-comment/SKILL.md +0 -89
- package/toolsets/toolsets/rzlv-flow/skills/jira-daily-triage/SKILL.md +0 -143
- package/toolsets/toolsets/rzlv-flow/skills/jira-sprint-status/SKILL.md +0 -143
- package/toolsets/toolsets/rzlv-flow/skills/jira-status/SKILL.md +0 -97
- package/toolsets/toolsets/rzlv-flow/skills/jira-sync/SKILL.md +0 -148
- package/toolsets/toolsets/rzlv-flow/skills/jira-ticket-focus/SKILL.md +0 -245
- package/toolsets/toolsets/rzlv-flow/skills/jira-ticket-trace/SKILL.md +0 -112
- package/toolsets/toolsets/rzlv-flow/skills/jira-wrap-sync/SKILL.md +0 -260
- /package/toolsets/{toolsets/rzlv-flow → rzlv-flow}/docs/getting-started.md +0 -0
- /package/toolsets/{toolsets/rzlv-flow → rzlv-flow}/skills/confluence-fetch/SKILL.md +0 -0
- /package/toolsets/{toolsets/rzlv-flow → rzlv-flow}/skills/confluence-publish/SKILL.md +0 -0
|
@@ -113,6 +113,7 @@ Confluence mirror files use this frontmatter:
|
|
|
113
113
|
sync:
|
|
114
114
|
confluence_page_id: "123456789" # Confluence page ID
|
|
115
115
|
confluence_url: "https://..." # Full page URL
|
|
116
|
+
confluence_title: "Page Title" # Exact title as it appears in Confluence
|
|
116
117
|
space: "ENG" # Confluence space key
|
|
117
118
|
parent_page_id: "987654321" # Parent page ID in Confluence
|
|
118
119
|
last_synced: "2025-12-11T10:30:00Z" # Last sync timestamp
|
|
@@ -126,6 +127,9 @@ source:
|
|
|
126
127
|
jira_ticket: "PROJ-120" # Associated Jira ticket (optional)
|
|
127
128
|
doc_type: "technical-architecture" # overview | technical | decisions | strategic
|
|
128
129
|
generated_from: "docs/jira/.../technical-architecture.md" # Source _docs/ file
|
|
130
|
+
bmad_docs_referenced: # BMAD source docs used (traceability)
|
|
131
|
+
- "docs/jira/.../technical-architecture.md"
|
|
132
|
+
jira_initiative_key: "PROJ-100" # Related Jira initiative (cross-linking)
|
|
129
133
|
|
|
130
134
|
# Flexible mode fields (use instead of structured fields)
|
|
131
135
|
# origin: "manual" # manual | context-analyst | other skill
|
|
@@ -207,3 +211,108 @@ Build a REST API endpoint for user authentication that accepts username/password
|
|
|
207
211
|
- Uses existing `UserService` for credential validation
|
|
208
212
|
- Token signing key stored in environment variables
|
|
209
213
|
```
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Complete Example: Synced Confluence Page (Structured Mode)
|
|
218
|
+
|
|
219
|
+
This example shows a Confluence page mirror created via the `atlassian-orchestrator` skill from an epic's `_docs/` folder. The file lives at:
|
|
220
|
+
|
|
221
|
+
```
|
|
222
|
+
docs/confluence/rezolve/ENG/platform-initiative/user-authentication/technical-architecture/index.md
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
Note the **Leaf Bundle** pattern: the page is a directory (`technical-architecture/`) containing `index.md`, not a flat `.md` file. See `confluence-file-structure.md` for details.
|
|
226
|
+
|
|
227
|
+
```yaml
|
|
228
|
+
---
|
|
229
|
+
sync:
|
|
230
|
+
confluence_page_id: "456789012"
|
|
231
|
+
confluence_url: "https://rezolve.atlassian.net/wiki/spaces/ENG/pages/456789012"
|
|
232
|
+
confluence_title: "Technical Architecture — User Authentication"
|
|
233
|
+
space: "ENG"
|
|
234
|
+
parent_page_id: "456789000"
|
|
235
|
+
last_synced: "2025-12-11T10:30:00Z"
|
|
236
|
+
version: 3
|
|
237
|
+
remote_updated: "2025-12-11T09:15:00Z"
|
|
238
|
+
|
|
239
|
+
mode: "structured"
|
|
240
|
+
|
|
241
|
+
source:
|
|
242
|
+
jira_ticket: "AIP-200"
|
|
243
|
+
doc_type: "technical-architecture"
|
|
244
|
+
generated_from: "docs/jira/rezolve/AIP/AIP-200-user-authentication/_docs/technical-architecture.md"
|
|
245
|
+
bmad_docs_referenced:
|
|
246
|
+
- "docs/jira/rezolve/AIP/AIP-200-user-authentication/_docs/technical-architecture.md"
|
|
247
|
+
jira_initiative_key: "AIP-100"
|
|
248
|
+
|
|
249
|
+
orchestrator:
|
|
250
|
+
generated_at: "2025-12-08T14:00:00Z"
|
|
251
|
+
auto_sync: true
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
# Technical Architecture — User Authentication
|
|
255
|
+
|
|
256
|
+
## Overview
|
|
257
|
+
|
|
258
|
+
REST API authentication using JWT tokens with bcrypt password hashing and Redis-backed rate limiting.
|
|
259
|
+
|
|
260
|
+
## Authentication Flow
|
|
261
|
+
|
|
262
|
+
1. Client sends POST `/api/auth/login` with credentials
|
|
263
|
+
2. Server validates against UserService
|
|
264
|
+
3. On success: sign JWT with RS256, return token + expiry
|
|
265
|
+
4. On failure: increment rate limiter, return 401
|
|
266
|
+
|
|
267
|
+
## Technology Decisions
|
|
268
|
+
|
|
269
|
+
- **JWT signing:** RS256 with rotating keys (see decisions.md)
|
|
270
|
+
- **Rate limiting:** Redis sliding window, 5 req/min/IP
|
|
271
|
+
- **Password storage:** bcrypt with cost factor 12
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
---
|
|
275
|
+
|
|
276
|
+
## Complete Example: Synced Confluence Page (Flexible Mode)
|
|
277
|
+
|
|
278
|
+
This example shows an ad-hoc page published to Confluence by a developer using the `confluence-publish` skill. The file lives at:
|
|
279
|
+
|
|
280
|
+
```
|
|
281
|
+
docs/confluence/rezolve/ENG/team-guides/onboarding-guide/index.md
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
```yaml
|
|
285
|
+
---
|
|
286
|
+
sync:
|
|
287
|
+
confluence_page_id: "789012345"
|
|
288
|
+
confluence_url: "https://rezolve.atlassian.net/wiki/spaces/ENG/pages/789012345"
|
|
289
|
+
confluence_title: "Developer Onboarding Guide"
|
|
290
|
+
space: "ENG"
|
|
291
|
+
parent_page_id: "789012000"
|
|
292
|
+
last_synced: "2025-12-12T14:00:00Z"
|
|
293
|
+
version: 1
|
|
294
|
+
remote_updated: "2025-12-12T14:00:00Z"
|
|
295
|
+
|
|
296
|
+
mode: "flexible"
|
|
297
|
+
|
|
298
|
+
source:
|
|
299
|
+
origin: "manual"
|
|
300
|
+
linked_jira: "AIP-300"
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
# Developer Onboarding Guide
|
|
304
|
+
|
|
305
|
+
Welcome to the team! This guide covers local setup, tooling, and key workflows.
|
|
306
|
+
|
|
307
|
+
## Local Setup
|
|
308
|
+
|
|
309
|
+
1. Clone the monorepo
|
|
310
|
+
2. Run `npm install` in the root
|
|
311
|
+
3. Copy `.env.example` to `.env` and fill in values
|
|
312
|
+
|
|
313
|
+
## Key Workflows
|
|
314
|
+
|
|
315
|
+
- **Daily triage:** Use `jira-daily-triage` to start your day
|
|
316
|
+
- **Ticket focus:** Use `jira-ticket-focus` to deep-load a ticket
|
|
317
|
+
- **Wrap up:** Use `jira-wrap-sync` when finishing work
|
|
318
|
+
```
|
|
@@ -40,9 +40,9 @@ Before executing, read these resource files for protocol and structure guidance:
|
|
|
40
40
|
```
|
|
41
41
|
JQL: project = {PROJECT} AND sprint in openSprints()
|
|
42
42
|
```
|
|
43
|
-
- Extract the sprint name and
|
|
44
|
-
- If no open sprint is found,
|
|
45
|
-
- Store the active sprint name and
|
|
43
|
+
- Extract the sprint name, ID, end date, and days remaining from the results.
|
|
44
|
+
- If no open sprint is found, display: "No active sprint detected — Backlog mode" and continue without a sprint filter. In Backlog mode, skip sprint-scoped queries and show only the user's assigned tickets ordered by priority.
|
|
45
|
+
- Store the active sprint name, ID, end date, and days remaining for the session.
|
|
46
46
|
|
|
47
47
|
> **Note:** Sprint data may be stored in custom fields whose names vary by Jira instance. When using MCP to query sprint tickets, inspect the returned fields for sprint information (name, start/end dates, goal). If sprint details are missing from the default field set, request additional fields or use `'*all'` to retrieve all fields.
|
|
48
48
|
|
|
@@ -90,7 +90,12 @@ Present results using this structure:
|
|
|
90
90
|
|
|
91
91
|
```
|
|
92
92
|
## 🌅 Your Day — {date}
|
|
93
|
-
**Project:** {PROJECT} | **Sprint:** {Sprint Name}
|
|
93
|
+
**Project:** {PROJECT} | **Sprint:** {Sprint Name} | **Ends:** {end_date} ({days_left} days left)
|
|
94
|
+
**Sprint Progress:** {X}/{Y} tickets complete
|
|
95
|
+
|
|
96
|
+
{IF NO SPRINT:}
|
|
97
|
+
## 🌅 Your Day — {date}
|
|
98
|
+
**Project:** {PROJECT} | **No active sprint detected — Backlog mode**
|
|
94
99
|
|
|
95
100
|
### 🔥 In Progress (Complete These First)
|
|
96
101
|
| # | Ticket | Summary | Points | Days Active |
|
|
@@ -114,7 +119,10 @@ Present results using this structure:
|
|
|
114
119
|
| 5 | PROJ-130 | Performance fix | 5 | Critical |
|
|
115
120
|
|
|
116
121
|
### ⚠️ Blockers & Flags
|
|
117
|
-
-
|
|
122
|
+
- {TICKET-KEY}: {blocker description} ({n} days)
|
|
123
|
+
- {TICKET-KEY}: {blocker description} ({n} days)
|
|
124
|
+
{IF NO BLOCKERS:}
|
|
125
|
+
✓ No blockers detected
|
|
118
126
|
|
|
119
127
|
**Recommended Focus:** #1 PROJ-123 (continue in-progress work) or #2 PROJ-124 (fresh start)
|
|
120
128
|
|
|
@@ -30,7 +30,7 @@ Use MCP to find the active sprint:
|
|
|
30
30
|
JQL: project = {PROJECT} AND sprint in openSprints()
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Extract the sprint name and
|
|
33
|
+
Extract the sprint name, ID, start date, end date, and sprint goal (if set). If no open sprint is found, inform the user and offer to report on a specific sprint or the full backlog.
|
|
34
34
|
|
|
35
35
|
> **Note:** Sprint data may be stored in custom fields whose names vary by Jira instance. When using MCP to query sprint tickets, inspect the returned fields for sprint information (name, start/end dates, goal). If sprint details are missing from the default field set, request additional fields or use `'*all'` to retrieve all fields.
|
|
36
36
|
|
|
@@ -59,6 +59,16 @@ Calculate:
|
|
|
59
59
|
- Overall completion percentage (done points / total points, or done count / total count)
|
|
60
60
|
- Sprint velocity so far (points completed)
|
|
61
61
|
|
|
62
|
+
### Step 4b: Calculate Velocity and Forecast
|
|
63
|
+
|
|
64
|
+
Using the sprint start date, end date, and points completed so far:
|
|
65
|
+
|
|
66
|
+
- **Days elapsed** — business days since sprint start
|
|
67
|
+
- **Days remaining** — business days until sprint end
|
|
68
|
+
- **Ideal velocity** — total points / total sprint days (points/day to finish on time)
|
|
69
|
+
- **Actual velocity** — done points / days elapsed
|
|
70
|
+
- **Forecast** — at current velocity, project whether the sprint will finish on time, ahead, or behind. If behind, estimate the shortfall: "May miss by {n} points"
|
|
71
|
+
|
|
62
72
|
### Step 5: Identify Risks
|
|
63
73
|
|
|
64
74
|
Flag potential risks:
|
|
@@ -81,6 +91,11 @@ Filter tickets assigned to the current user:
|
|
|
81
91
|
```
|
|
82
92
|
## 📊 Sprint Status: {Sprint Name}
|
|
83
93
|
**Project:** {PROJECT} | **Sprint:** {Sprint Name}
|
|
94
|
+
**Ends:** {end_date} ({days_left} days left)
|
|
95
|
+
{IF SPRINT GOAL SET:}
|
|
96
|
+
**Goal:** {Sprint Goal}
|
|
97
|
+
|
|
98
|
+
████████████░░░░░░░░ {percent}% Complete
|
|
84
99
|
|
|
85
100
|
### Progress
|
|
86
101
|
| Status | Tickets | Story Points |
|
|
@@ -92,6 +107,11 @@ Filter tickets assigned to the current user:
|
|
|
92
107
|
|
|
93
108
|
**Completion:** {percent}% by points ({done_pts}/{total_pts})
|
|
94
109
|
|
|
110
|
+
### Velocity & Forecast
|
|
111
|
+
- **Ideal:** {n} points/day
|
|
112
|
+
- **Actual:** {n} points/day
|
|
113
|
+
- **Forecast:** {On track | Ahead by {n} points | May miss by {n} points}
|
|
114
|
+
|
|
95
115
|
### Ticket Breakdown
|
|
96
116
|
| # | Ticket | Summary | Status | Assignee | Points |
|
|
97
117
|
|---|--------|---------|--------|----------|--------|
|
|
@@ -113,4 +133,11 @@ Filter tickets assigned to the current user:
|
|
|
113
133
|
- **Completed:** {n} tickets ({pts} pts)
|
|
114
134
|
- **In Progress:** {n} tickets ({pts} pts)
|
|
115
135
|
- **Assigned (To Do):** {n} tickets ({pts} pts)
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
**Quick Actions:**
|
|
139
|
+
1. View at-risk tickets in detail
|
|
140
|
+
2. Focus on blocked items
|
|
141
|
+
3. Generate standup update (summary for copy/paste)
|
|
142
|
+
4. Export sprint data as markdown table
|
|
116
143
|
```
|
|
@@ -25,7 +25,10 @@ Before executing, read these resource files — they are critical for correct be
|
|
|
25
25
|
- If the user provides a **number** (e.g. "3"), look it up from the `numbered_ticket_list` stored in conversational context from a prior `jira-daily-triage` run.
|
|
26
26
|
- If the user provides a **Jira key** (e.g. "PROJ-123"), use it directly.
|
|
27
27
|
- If the key is **incomplete** (e.g. "123"), prepend the `confirmed_project` key from session context (e.g. "PROJ-123").
|
|
28
|
-
- If neither a number mapping nor a project key is available,
|
|
28
|
+
- If neither a number mapping nor a project key is available, attempt fallback detection:
|
|
29
|
+
1. **Git branch:** Check the current branch name for a `{PROJECT}-{n}` pattern (e.g. `feature/PROJ-123` → project is `PROJ`).
|
|
30
|
+
2. **Config file:** Check for a `.jira.json` file in the project root containing `{ "project": "PROJ", "instance": "rezolve" }`.
|
|
31
|
+
3. If neither yields a project key, ask the user for the full ticket key.
|
|
29
32
|
|
|
30
33
|
### Step 2: Fetch Ticket Details (FCMP Fetch Step)
|
|
31
34
|
|
|
@@ -35,6 +38,8 @@ Use `mcp_atlassian-rovo_fetch()` to retrieve:
|
|
|
35
38
|
- Comments and recent history
|
|
36
39
|
- Sprint information (use `active_sprint_name` from session context if available)
|
|
37
40
|
- Linked Confluence documents (if any)
|
|
41
|
+
- **Subtasks** — fetch all subtasks of the ticket via JQL: `parent = {TICKET-KEY} ORDER BY status ASC, priority DESC`
|
|
42
|
+
- **Linked issues** — fetch linked issues (blocks, is blocked by, relates to)
|
|
38
43
|
|
|
39
44
|
**Parent Epic detection** — check in this order:
|
|
40
45
|
|
|
@@ -40,12 +40,23 @@ Before executing, read these resource files:
|
|
|
40
40
|
- Map code changes to acceptance criteria where possible.
|
|
41
41
|
- Summarize: files changed, insertions, deletions.
|
|
42
42
|
|
|
43
|
+
**c) Acceptance criteria progress:**
|
|
44
|
+
- Read the AC list from the ticket file.
|
|
45
|
+
- Based on code changes and commit messages, infer which AC items have been completed.
|
|
46
|
+
- Show checkbox progress:
|
|
47
|
+
```
|
|
48
|
+
- [x] AC 1 — Completed (matches changes in auth-controller.ts)
|
|
49
|
+
- [x] AC 2 — Completed (matches changes in rate-limiter.ts)
|
|
50
|
+
- [ ] AC 3 — Not yet addressed
|
|
51
|
+
```
|
|
52
|
+
- Note: this is a best-effort inference. The user confirms the final state.
|
|
53
|
+
|
|
43
54
|
### Step 3: Draft Jira Comment
|
|
44
55
|
|
|
45
|
-
Build a comprehensive comment
|
|
56
|
+
Build a comprehensive comment with the standardized prefix `[rzlv-flow Update]`:
|
|
46
57
|
|
|
47
58
|
```
|
|
48
|
-
|
|
59
|
+
[rzlv-flow Update]
|
|
49
60
|
|
|
50
61
|
{IF TICKET FIELD CHANGES:}
|
|
51
62
|
**Ticket Updates:**
|
|
@@ -61,22 +72,44 @@ Build a comprehensive comment covering both ticket updates and code progress:
|
|
|
61
72
|
- {file1}: {brief description}
|
|
62
73
|
- {file2}: {brief description}
|
|
63
74
|
|
|
64
|
-
**
|
|
65
|
-
|
|
75
|
+
**Acceptance Criteria:**
|
|
76
|
+
- [x] {completed AC 1}
|
|
77
|
+
- [x] {completed AC 2}
|
|
78
|
+
- [ ] {remaining AC 3}
|
|
79
|
+
**Progress:** {X}/{Y} completed
|
|
66
80
|
|
|
67
81
|
**Next Steps:** {suggested next action}
|
|
82
|
+
|
|
83
|
+
Context: {optional PR link or Confluence doc link}
|
|
68
84
|
```
|
|
69
85
|
|
|
70
|
-
### Step 4: FCMP
|
|
86
|
+
### Step 4: FCMP Preview (Prepare PUSH — Dry Run)
|
|
71
87
|
|
|
72
|
-
Before executing any write operations, run the full FCMP cycle:
|
|
88
|
+
Before executing any write operations, run the full FCMP cycle and present a dry-run preview:
|
|
73
89
|
|
|
74
90
|
1. **FETCH** — Get the current ticket state from Jira via MCP.
|
|
75
91
|
2. **COMPARE** — Check for remote changes since last sync (compare `sync.version` and `sync.remote_updated`).
|
|
76
92
|
3. **MERGE** — If conflicts detected, show a diff of remote changes vs local changes and resolve with the user.
|
|
77
|
-
4. Show
|
|
93
|
+
4. **Preview** — Show a dry-run diff of what will change if the user proceeds:
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
### FCMP Preview (Dry Run)
|
|
97
|
+
{IF NO REMOTE CHANGES:}
|
|
98
|
+
✓ Remote is unchanged since last sync — safe to push.
|
|
99
|
+
|
|
100
|
+
{IF REMOTE CHANGES DETECTED:}
|
|
101
|
+
⚠️ Remote changes detected since last sync:
|
|
102
|
+
- {field}: {old_value} → {new_value}
|
|
103
|
+
|
|
104
|
+
**Proposed local → remote changes:**
|
|
105
|
+
- Description: {diff summary}
|
|
106
|
+
- Story Points: {old} → {new}
|
|
107
|
+
- Status: {current} (no change)
|
|
108
|
+
|
|
109
|
+
Proceed with sync? (y/n)
|
|
110
|
+
```
|
|
78
111
|
|
|
79
|
-
Only proceed to the action menu after the FCMP
|
|
112
|
+
Only proceed to the action menu after the FCMP preview is confirmed.
|
|
80
113
|
|
|
81
114
|
### Step 5: Present Multi-Select Action Menu
|
|
82
115
|
|
package/skills/skills/README.md
DELETED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
# Skills
|
|
2
|
-
|
|
3
|
-
This folder manages all skills, archived skills, and examples/instructions on using them.
|
|
4
|
-
|
|
5
|
-
All skills in this `skills/library/` should represent _generally useful skills_ that might be used across teams.
|
|
6
|
-
|
|
7
|
-
If any particular skill goes missing, note that it may have simply been archived (see [the archive](skills/archived/)) and may no longer be recommended for use. Ideally skills are not simply deleted from this repository, since others may be expecting them to be there.
|
|
8
|
-
|
|
9
|
-
## Usage
|
|
10
|
-
|
|
11
|
-
When developing a project, it is generally recommended to commit any skills you use to that codebase so that others may use them as well. Skills are stored as folders and can include many files, but need to include at least a SKILL.md file. Normal locations are:
|
|
12
|
-
|
|
13
|
-
* **Claude Code**: `.claude/skills/<skill-name>/`
|
|
14
|
-
* **Copilot**: `.github/skills/<skill-name>/`
|
|
15
|
-
* **Codex**: `.agents/skills/<skill-name>/`
|
|
16
|
-
* Codex allows for storing skills in [many places](https://developers.openai.com/codex/skills#where-to-save-skills), including outside the repo.
|
|
17
|
-
|
|
18
|
-
Note that each folder must contain a SKILL.md file, and may optionally contain other arbitrary files:
|
|
19
|
-
* Other markdown files that describe processes
|
|
20
|
-
* Script files that allow for deterministic coding
|
|
21
|
-
* ...plus other resources required by either
|
|
22
|
-
|
|
23
|
-
All of the above should be referenced directly by their SKILL.md file, with an explanation on when to read or use them.
|
|
24
|
-
|
|
25
|
-
## Recommended usage
|
|
26
|
-
|
|
27
|
-
However, to allow everyone to use skills regardless of their LLM client of choice, it can be valuable to do the following:
|
|
28
|
-
|
|
29
|
-
* Store the skill folder in a place like `docs/ai/skills/<skill-name>/`
|
|
30
|
-
* Reference the skill in the folder for each relevant client.
|
|
31
|
-
|
|
32
|
-
For example:
|
|
33
|
-
|
|
34
|
-
In `docs/ai/skills/frontend-design/SKILL.md`:
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
---
|
|
38
|
-
name: frontend-design
|
|
39
|
-
description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
This skill guides creation of distinctive, production-grade frontend interfaces that avoid generic "AI slop" aesthetics. Implement real working code with exceptional attention to aesthetic details and creative choices.
|
|
43
|
-
|
|
44
|
-
The user provides frontend requirements: a component, page, application, or interface to build. They may include context about the purpose, audience, or technical constraints.
|
|
45
|
-
|
|
46
|
-
...
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
Then, in `.github/skills/frontend-design/SKILL.md` (and anywhere else needed):
|
|
50
|
-
|
|
51
|
-
```
|
|
52
|
-
---
|
|
53
|
-
name: frontend-design
|
|
54
|
-
description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
|
|
55
|
-
license: Complete terms in LICENSE.txt
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
See `docs/ai/skills/frontend-design/SKILL.md` and follow closely.
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Note that we MUST include the skill boilerplate in any official skills location (eg. `.github/skills/`, etc.) to enable discovery and usage. We then copy the entire skill into `docs/ai/skills/` to leave it intact, though we don't technically need the boilerplate.
|
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
Apache License
|
|
3
|
-
Version 2.0, January 2004
|
|
4
|
-
http://www.apache.org/licenses/
|
|
5
|
-
|
|
6
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
-
|
|
8
|
-
1. Definitions.
|
|
9
|
-
|
|
10
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
-
|
|
13
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
-
the copyright owner that is granting the License.
|
|
15
|
-
|
|
16
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
-
other entities that control, are controlled by, or are under common
|
|
18
|
-
control with that entity. For the purposes of this definition,
|
|
19
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
-
direction or management of such entity, whether by contract or
|
|
21
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
-
|
|
24
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
-
exercising permissions granted by this License.
|
|
26
|
-
|
|
27
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
-
including but not limited to software source code, documentation
|
|
29
|
-
source, and configuration files.
|
|
30
|
-
|
|
31
|
-
"Object" form shall mean any form resulting from mechanical
|
|
32
|
-
transformation or translation of a Source form, including but
|
|
33
|
-
not limited to compiled object code, generated documentation,
|
|
34
|
-
and conversions to other media types.
|
|
35
|
-
|
|
36
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
-
Object form, made available under the License, as indicated by a
|
|
38
|
-
copyright notice that is included in or attached to the work
|
|
39
|
-
(an example is provided in the Appendix below).
|
|
40
|
-
|
|
41
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
-
form, that is based on (or derived from) the Work and for which the
|
|
43
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
-
of this License, Derivative Works shall not include works that remain
|
|
46
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
-
the Work and Derivative Works thereof.
|
|
48
|
-
|
|
49
|
-
"Contribution" shall mean any work of authorship, including
|
|
50
|
-
the original version of the Work and any modifications or additions
|
|
51
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
-
means any form of electronic, verbal, or written communication sent
|
|
56
|
-
to the Licensor or its representatives, including but not limited to
|
|
57
|
-
communication on electronic mailing lists, source code control systems,
|
|
58
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
-
excluding communication that is conspicuously marked or otherwise
|
|
61
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
-
|
|
63
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
-
subsequently incorporated within the Work.
|
|
66
|
-
|
|
67
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
-
Work and such Derivative Works in Source or Object form.
|
|
73
|
-
|
|
74
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
-
(except as stated in this section) patent license to make, have made,
|
|
78
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
-
where such license applies only to those patent claims licensable
|
|
80
|
-
by such Contributor that are necessarily infringed by their
|
|
81
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
-
institute patent litigation against any entity (including a
|
|
84
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
-
or contributory patent infringement, then any patent licenses
|
|
87
|
-
granted to You under this License for that Work shall terminate
|
|
88
|
-
as of the date such litigation is filed.
|
|
89
|
-
|
|
90
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
-
modifications, and in Source or Object form, provided that You
|
|
93
|
-
meet the following conditions:
|
|
94
|
-
|
|
95
|
-
(a) You must give any other recipients of the Work or
|
|
96
|
-
Derivative Works a copy of this License; and
|
|
97
|
-
|
|
98
|
-
(b) You must cause any modified files to carry prominent notices
|
|
99
|
-
stating that You changed the files; and
|
|
100
|
-
|
|
101
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
-
that You distribute, all copyright, patent, trademark, and
|
|
103
|
-
attribution notices from the Source form of the Work,
|
|
104
|
-
excluding those notices that do not pertain to any part of
|
|
105
|
-
the Derivative Works; and
|
|
106
|
-
|
|
107
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
-
distribution, then any Derivative Works that You distribute must
|
|
109
|
-
include a readable copy of the attribution notices contained
|
|
110
|
-
within such NOTICE file, excluding those notices that do not
|
|
111
|
-
pertain to any part of the Derivative Works, in at least one
|
|
112
|
-
of the following places: within a NOTICE text file distributed
|
|
113
|
-
as part of the Derivative Works; within the Source form or
|
|
114
|
-
documentation, if provided along with the Derivative Works; or,
|
|
115
|
-
within a display generated by the Derivative Works, if and
|
|
116
|
-
wherever such third-party notices normally appear. The contents
|
|
117
|
-
of the NOTICE file are for informational purposes only and
|
|
118
|
-
do not modify the License. You may add Your own attribution
|
|
119
|
-
notices within Derivative Works that You distribute, alongside
|
|
120
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
-
that such additional attribution notices cannot be construed
|
|
122
|
-
as modifying the License.
|
|
123
|
-
|
|
124
|
-
You may add Your own copyright statement to Your modifications and
|
|
125
|
-
may provide additional or different license terms and conditions
|
|
126
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
-
the conditions stated in this License.
|
|
130
|
-
|
|
131
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
-
this License, without any additional terms or conditions.
|
|
135
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
-
the terms of any separate license agreement you may have executed
|
|
137
|
-
with Licensor regarding such Contributions.
|
|
138
|
-
|
|
139
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
-
except as required for reasonable and customary use in describing the
|
|
142
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
-
|
|
144
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
-
implied, including, without limitation, any warranties or conditions
|
|
149
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
-
appropriateness of using or redistributing the Work and assume any
|
|
152
|
-
risks associated with Your exercise of permissions under this License.
|
|
153
|
-
|
|
154
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
-
unless required by applicable law (such as deliberate and grossly
|
|
157
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
-
liable to You for damages, including any direct, indirect, special,
|
|
159
|
-
incidental, or consequential damages of any character arising as a
|
|
160
|
-
result of this License or out of the use or inability to use the
|
|
161
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
-
other commercial damages or losses), even if such Contributor
|
|
164
|
-
has been advised of the possibility of such damages.
|
|
165
|
-
|
|
166
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
-
or other liability obligations and/or rights consistent with this
|
|
170
|
-
License. However, in accepting such obligations, You may act only
|
|
171
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
-
defend, and hold each Contributor harmless for any liability
|
|
174
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
-
of your accepting any such warranty or additional liability.
|
|
176
|
-
|
|
177
|
-
END OF TERMS AND CONDITIONS
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: frontend-design
|
|
3
|
-
description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
|
|
4
|
-
license: Complete terms in LICENSE.txt
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
This skill guides creation of distinctive, production-grade frontend interfaces that avoid generic "AI slop" aesthetics. Implement real working code with exceptional attention to aesthetic details and creative choices.
|
|
8
|
-
|
|
9
|
-
The user provides frontend requirements: a component, page, application, or interface to build. They may include context about the purpose, audience, or technical constraints.
|
|
10
|
-
|
|
11
|
-
## Design Thinking
|
|
12
|
-
|
|
13
|
-
Before coding, understand the context and commit to a BOLD aesthetic direction:
|
|
14
|
-
- **Purpose**: What problem does this interface solve? Who uses it?
|
|
15
|
-
- **Tone**: Pick an extreme: brutally minimal, maximalist chaos, retro-futuristic, organic/natural, luxury/refined, playful/toy-like, editorial/magazine, brutalist/raw, art deco/geometric, soft/pastel, industrial/utilitarian, etc. There are so many flavors to choose from. Use these for inspiration but design one that is true to the aesthetic direction.
|
|
16
|
-
- **Constraints**: Technical requirements (framework, performance, accessibility).
|
|
17
|
-
- **Differentiation**: What makes this UNFORGETTABLE? What's the one thing someone will remember?
|
|
18
|
-
|
|
19
|
-
**CRITICAL**: Choose a clear conceptual direction and execute it with precision. Bold maximalism and refined minimalism both work - the key is intentionality, not intensity.
|
|
20
|
-
|
|
21
|
-
Then implement working code (HTML/CSS/JS, React, Vue, etc.) that is:
|
|
22
|
-
- Production-grade and functional
|
|
23
|
-
- Visually striking and memorable
|
|
24
|
-
- Cohesive with a clear aesthetic point-of-view
|
|
25
|
-
- Meticulously refined in every detail
|
|
26
|
-
|
|
27
|
-
## Frontend Aesthetics Guidelines
|
|
28
|
-
|
|
29
|
-
Focus on:
|
|
30
|
-
- **Typography**: Choose fonts that are beautiful, unique, and interesting. Avoid generic fonts like Arial and Inter; opt instead for distinctive choices that elevate the frontend's aesthetics; unexpected, characterful font choices. Pair a distinctive display font with a refined body font.
|
|
31
|
-
- **Color & Theme**: Commit to a cohesive aesthetic. Use CSS variables for consistency. Dominant colors with sharp accents outperform timid, evenly-distributed palettes.
|
|
32
|
-
- **Motion**: Use animations for effects and micro-interactions. Prioritize CSS-only solutions for HTML. Use Motion library for React when available. Focus on high-impact moments: one well-orchestrated page load with staggered reveals (animation-delay) creates more delight than scattered micro-interactions. Use scroll-triggering and hover states that surprise.
|
|
33
|
-
- **Spatial Composition**: Unexpected layouts. Asymmetry. Overlap. Diagonal flow. Grid-breaking elements. Generous negative space OR controlled density.
|
|
34
|
-
- **Backgrounds & Visual Details**: Create atmosphere and depth rather than defaulting to solid colors. Add contextual effects and textures that match the overall aesthetic. Apply creative forms like gradient meshes, noise textures, geometric patterns, layered transparencies, dramatic shadows, decorative borders, custom cursors, and grain overlays.
|
|
35
|
-
|
|
36
|
-
NEVER use generic AI-generated aesthetics like overused font families (Inter, Roboto, Arial, system fonts), cliched color schemes (particularly purple gradients on white backgrounds), predictable layouts and component patterns, and cookie-cutter design that lacks context-specific character.
|
|
37
|
-
|
|
38
|
-
Interpret creatively and make unexpected choices that feel genuinely designed for the context. No design should be the same. Vary between light and dark themes, different fonts, different aesthetics. NEVER converge on common choices (Space Grotesk, for example) across generations.
|
|
39
|
-
|
|
40
|
-
**IMPORTANT**: Match implementation complexity to the aesthetic vision. Maximalist designs need elaborate code with extensive animations and effects. Minimalist or refined designs need restraint, precision, and careful attention to spacing, typography, and subtle details. Elegance comes from executing the vision well.
|
|
41
|
-
|
|
42
|
-
Remember: Claude is capable of extraordinary creative work. Don't hold back, show what can truly be created when thinking outside the box and committing fully to a distinctive vision.
|