@bradygaster/squad-sdk 0.9.0 → 0.9.1

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.
Files changed (76) hide show
  1. package/README.md +296 -296
  2. package/dist/agents/history-shadow.js +30 -30
  3. package/dist/build/github-dist.js +42 -42
  4. package/dist/config/init.js +173 -173
  5. package/dist/sharing/consult.js +78 -78
  6. package/package.json +1 -1
  7. package/templates/casting/Futurama.json +9 -9
  8. package/templates/casting-history.json +4 -4
  9. package/templates/casting-policy.json +37 -37
  10. package/templates/casting-reference.md +104 -104
  11. package/templates/casting-registry.json +3 -3
  12. package/templates/ceremonies.md +41 -41
  13. package/templates/charter.md +53 -53
  14. package/templates/constraint-tracking.md +38 -38
  15. package/templates/cooperative-rate-limiting.md +229 -229
  16. package/templates/copilot-instructions.md +46 -46
  17. package/templates/history.md +10 -10
  18. package/templates/identity/now.md +9 -9
  19. package/templates/identity/wisdom.md +15 -15
  20. package/templates/issue-lifecycle.md +412 -412
  21. package/templates/keda-scaler.md +164 -164
  22. package/templates/machine-capabilities.md +74 -74
  23. package/templates/mcp-config.md +90 -90
  24. package/templates/multi-agent-format.md +28 -28
  25. package/templates/plugin-marketplace.md +49 -49
  26. package/templates/ralph-circuit-breaker.md +313 -313
  27. package/templates/raw-agent-output.md +37 -37
  28. package/templates/roster.md +60 -60
  29. package/templates/routing.md +39 -39
  30. package/templates/run-output.md +50 -50
  31. package/templates/schedule.json +19 -19
  32. package/templates/scribe-charter.md +119 -119
  33. package/templates/skill.md +24 -24
  34. package/templates/skills/agent-collaboration/SKILL.md +42 -42
  35. package/templates/skills/agent-conduct/SKILL.md +24 -24
  36. package/templates/skills/architectural-proposals/SKILL.md +151 -151
  37. package/templates/skills/ci-validation-gates/SKILL.md +84 -84
  38. package/templates/skills/cli-wiring/SKILL.md +47 -47
  39. package/templates/skills/client-compatibility/SKILL.md +89 -89
  40. package/templates/skills/cross-squad/SKILL.md +114 -114
  41. package/templates/skills/distributed-mesh/SKILL.md +287 -287
  42. package/templates/skills/distributed-mesh/mesh.json.example +30 -30
  43. package/templates/skills/distributed-mesh/sync-mesh.ps1 +111 -111
  44. package/templates/skills/distributed-mesh/sync-mesh.sh +104 -104
  45. package/templates/skills/docs-standards/SKILL.md +71 -71
  46. package/templates/skills/economy-mode/SKILL.md +114 -114
  47. package/templates/skills/external-comms/SKILL.md +329 -329
  48. package/templates/skills/gh-auth-isolation/SKILL.md +183 -183
  49. package/templates/skills/git-workflow/SKILL.md +204 -204
  50. package/templates/skills/github-multi-account/SKILL.md +95 -95
  51. package/templates/skills/history-hygiene/SKILL.md +36 -36
  52. package/templates/skills/humanizer/SKILL.md +105 -105
  53. package/templates/skills/init-mode/SKILL.md +102 -102
  54. package/templates/skills/model-selection/SKILL.md +117 -117
  55. package/templates/skills/nap/SKILL.md +24 -24
  56. package/templates/skills/personal-squad/SKILL.md +57 -57
  57. package/templates/skills/project-conventions/SKILL.md +56 -56
  58. package/templates/skills/release-process/SKILL.md +423 -423
  59. package/templates/skills/reskill/SKILL.md +92 -92
  60. package/templates/skills/reviewer-protocol/SKILL.md +79 -79
  61. package/templates/skills/secret-handling/SKILL.md +200 -200
  62. package/templates/skills/session-recovery/SKILL.md +155 -155
  63. package/templates/skills/squad-conventions/SKILL.md +69 -69
  64. package/templates/skills/test-discipline/SKILL.md +37 -37
  65. package/templates/skills/windows-compatibility/SKILL.md +74 -74
  66. package/templates/workflows/squad-ci.yml +24 -24
  67. package/templates/workflows/squad-docs.yml +54 -54
  68. package/templates/workflows/squad-heartbeat.yml +171 -171
  69. package/templates/workflows/squad-insider-release.yml +61 -61
  70. package/templates/workflows/squad-issue-assign.yml +161 -161
  71. package/templates/workflows/squad-label-enforce.yml +181 -181
  72. package/templates/workflows/squad-preview.yml +55 -55
  73. package/templates/workflows/squad-promote.yml +120 -120
  74. package/templates/workflows/squad-release.yml +77 -77
  75. package/templates/workflows/squad-triage.yml +260 -260
  76. package/templates/workflows/sync-squad-labels.yml +169 -169
@@ -1,117 +1,117 @@
1
- # Model Selection
2
-
3
- > Determines which LLM model to use for each agent spawn.
4
-
5
- ## SCOPE
6
-
7
- ✅ THIS SKILL PRODUCES:
8
- - A resolved `model` parameter for every `task` tool call
9
- - Persistent model preferences in `.squad/config.json`
10
- - Spawn acknowledgments that include the resolved model
11
-
12
- ❌ THIS SKILL DOES NOT PRODUCE:
13
- - Code, tests, or documentation
14
- - Model performance benchmarks
15
- - Cost reports or billing artifacts
16
-
17
- ## Context
18
-
19
- Squad supports 18+ models across three tiers (premium, standard, fast). The coordinator must select the right model for each agent spawn. Users can set persistent preferences that survive across sessions.
20
-
21
- ## 5-Layer Model Resolution Hierarchy
22
-
23
- Resolution is **first-match-wins** — the highest layer with a value wins.
24
-
25
- | Layer | Name | Source | Persistence |
26
- |-------|------|--------|-------------|
27
- | **0a** | Per-Agent Config | `.squad/config.json` → `agentModelOverrides.{name}` | Persistent (survives sessions) |
28
- | **0b** | Global Config | `.squad/config.json` → `defaultModel` | Persistent (survives sessions) |
29
- | **1** | Session Directive | User said "use X" in current session | Session-only |
30
- | **2** | Charter Preference | Agent's `charter.md` → `## Model` section | Persistent (in charter) |
31
- | **3** | Task-Aware Auto | Code → sonnet, docs → haiku, visual → opus | Computed per-spawn |
32
- | **4** | Default | `claude-haiku-4.5` | Hardcoded fallback |
33
-
34
- **Key principle:** Layer 0 (persistent config) beats everything. If the user said "always use opus" and it was saved to config.json, every agent gets opus regardless of role or task type. This is intentional — the user explicitly chose quality over cost.
35
-
36
- ## AGENT WORKFLOW
37
-
38
- ### On Session Start
39
-
40
- 1. READ `.squad/config.json`
41
- 2. CHECK for `defaultModel` field — if present, this is the Layer 0 override for all spawns
42
- 3. CHECK for `agentModelOverrides` field — if present, these are per-agent Layer 0a overrides
43
- 4. STORE both values in session context for the duration
44
-
45
- ### On Every Agent Spawn
46
-
47
- 1. CHECK Layer 0a: Is there an `agentModelOverrides.{agentName}` in config.json? → Use it.
48
- 2. CHECK Layer 0b: Is there a `defaultModel` in config.json? → Use it.
49
- 3. CHECK Layer 1: Did the user give a session directive? → Use it.
50
- 4. CHECK Layer 2: Does the agent's charter have a `## Model` section? → Use it.
51
- 5. CHECK Layer 3: Determine task type:
52
- - Code (implementation, tests, refactoring, bug fixes) → `claude-sonnet-4.6`
53
- - Prompts, agent designs → `claude-sonnet-4.6`
54
- - Visual/design with image analysis → `claude-opus-4.6`
55
- - Non-code (docs, planning, triage, changelogs) → `claude-haiku-4.5`
56
- 6. FALLBACK Layer 4: `claude-haiku-4.5`
57
- 7. INCLUDE model in spawn acknowledgment: `🔧 {Name} ({resolved_model}) — {task}`
58
-
59
- ### When User Sets a Preference
60
-
61
- **Trigger phrases:** "always use X", "use X for everything", "switch to X", "default to X"
62
-
63
- 1. VALIDATE the model ID against the catalog (18+ models)
64
- 2. WRITE `defaultModel` to `.squad/config.json` (merge, don't overwrite)
65
- 3. ACKNOWLEDGE: `✅ Model preference saved: {model} — all future sessions will use this until changed.`
66
-
67
- **Per-agent trigger:** "use X for {agent}"
68
-
69
- 1. VALIDATE model ID
70
- 2. WRITE to `agentModelOverrides.{agent}` in `.squad/config.json`
71
- 3. ACKNOWLEDGE: `✅ {Agent} will always use {model} — saved to config.`
72
-
73
- ### When User Clears a Preference
74
-
75
- **Trigger phrases:** "switch back to automatic", "clear model preference", "use default models"
76
-
77
- 1. REMOVE `defaultModel` from `.squad/config.json`
78
- 2. ACKNOWLEDGE: `✅ Model preference cleared — returning to automatic selection.`
79
-
80
- ### STOP
81
-
82
- After resolving the model and including it in the spawn template, this skill is done. Do NOT:
83
- - Generate model comparison reports
84
- - Run benchmarks or speed tests
85
- - Create new config files (only modify existing `.squad/config.json`)
86
- - Change the model after spawn (fallback chains handle runtime failures)
87
-
88
- ## Config Schema
89
-
90
- `.squad/config.json` model-related fields:
91
-
92
- ```json
93
- {
94
- "version": 1,
95
- "defaultModel": "claude-opus-4.6",
96
- "agentModelOverrides": {
97
- "fenster": "claude-sonnet-4.6",
98
- "mcmanus": "claude-haiku-4.5"
99
- }
100
- }
101
- ```
102
-
103
- - `defaultModel` — applies to ALL agents unless overridden by `agentModelOverrides`
104
- - `agentModelOverrides` — per-agent overrides that take priority over `defaultModel`
105
- - Both fields are optional. When absent, Layers 1-4 apply normally.
106
-
107
- ## Fallback Chains
108
-
109
- If a model is unavailable (rate limit, plan restriction), retry within the same tier:
110
-
111
- ```
112
- Premium: claude-opus-4.6 → claude-opus-4.6-fast → claude-opus-4.5 → claude-sonnet-4.6
113
- Standard: claude-sonnet-4.6 → gpt-5.4 → claude-sonnet-4.5 → gpt-5.3-codex → claude-sonnet-4
114
- Fast: claude-haiku-4.5 → gpt-5.1-codex-mini → gpt-4.1 → gpt-5-mini
115
- ```
116
-
117
- **Never fall UP in tier.** A fast task won't land on a premium model via fallback.
1
+ # Model Selection
2
+
3
+ > Determines which LLM model to use for each agent spawn.
4
+
5
+ ## SCOPE
6
+
7
+ ✅ THIS SKILL PRODUCES:
8
+ - A resolved `model` parameter for every `task` tool call
9
+ - Persistent model preferences in `.squad/config.json`
10
+ - Spawn acknowledgments that include the resolved model
11
+
12
+ ❌ THIS SKILL DOES NOT PRODUCE:
13
+ - Code, tests, or documentation
14
+ - Model performance benchmarks
15
+ - Cost reports or billing artifacts
16
+
17
+ ## Context
18
+
19
+ Squad supports 18+ models across three tiers (premium, standard, fast). The coordinator must select the right model for each agent spawn. Users can set persistent preferences that survive across sessions.
20
+
21
+ ## 5-Layer Model Resolution Hierarchy
22
+
23
+ Resolution is **first-match-wins** — the highest layer with a value wins.
24
+
25
+ | Layer | Name | Source | Persistence |
26
+ |-------|------|--------|-------------|
27
+ | **0a** | Per-Agent Config | `.squad/config.json` → `agentModelOverrides.{name}` | Persistent (survives sessions) |
28
+ | **0b** | Global Config | `.squad/config.json` → `defaultModel` | Persistent (survives sessions) |
29
+ | **1** | Session Directive | User said "use X" in current session | Session-only |
30
+ | **2** | Charter Preference | Agent's `charter.md` → `## Model` section | Persistent (in charter) |
31
+ | **3** | Task-Aware Auto | Code → sonnet, docs → haiku, visual → opus | Computed per-spawn |
32
+ | **4** | Default | `claude-haiku-4.5` | Hardcoded fallback |
33
+
34
+ **Key principle:** Layer 0 (persistent config) beats everything. If the user said "always use opus" and it was saved to config.json, every agent gets opus regardless of role or task type. This is intentional — the user explicitly chose quality over cost.
35
+
36
+ ## AGENT WORKFLOW
37
+
38
+ ### On Session Start
39
+
40
+ 1. READ `.squad/config.json`
41
+ 2. CHECK for `defaultModel` field — if present, this is the Layer 0 override for all spawns
42
+ 3. CHECK for `agentModelOverrides` field — if present, these are per-agent Layer 0a overrides
43
+ 4. STORE both values in session context for the duration
44
+
45
+ ### On Every Agent Spawn
46
+
47
+ 1. CHECK Layer 0a: Is there an `agentModelOverrides.{agentName}` in config.json? → Use it.
48
+ 2. CHECK Layer 0b: Is there a `defaultModel` in config.json? → Use it.
49
+ 3. CHECK Layer 1: Did the user give a session directive? → Use it.
50
+ 4. CHECK Layer 2: Does the agent's charter have a `## Model` section? → Use it.
51
+ 5. CHECK Layer 3: Determine task type:
52
+ - Code (implementation, tests, refactoring, bug fixes) → `claude-sonnet-4.6`
53
+ - Prompts, agent designs → `claude-sonnet-4.6`
54
+ - Visual/design with image analysis → `claude-opus-4.6`
55
+ - Non-code (docs, planning, triage, changelogs) → `claude-haiku-4.5`
56
+ 6. FALLBACK Layer 4: `claude-haiku-4.5`
57
+ 7. INCLUDE model in spawn acknowledgment: `🔧 {Name} ({resolved_model}) — {task}`
58
+
59
+ ### When User Sets a Preference
60
+
61
+ **Trigger phrases:** "always use X", "use X for everything", "switch to X", "default to X"
62
+
63
+ 1. VALIDATE the model ID against the catalog (18+ models)
64
+ 2. WRITE `defaultModel` to `.squad/config.json` (merge, don't overwrite)
65
+ 3. ACKNOWLEDGE: `✅ Model preference saved: {model} — all future sessions will use this until changed.`
66
+
67
+ **Per-agent trigger:** "use X for {agent}"
68
+
69
+ 1. VALIDATE model ID
70
+ 2. WRITE to `agentModelOverrides.{agent}` in `.squad/config.json`
71
+ 3. ACKNOWLEDGE: `✅ {Agent} will always use {model} — saved to config.`
72
+
73
+ ### When User Clears a Preference
74
+
75
+ **Trigger phrases:** "switch back to automatic", "clear model preference", "use default models"
76
+
77
+ 1. REMOVE `defaultModel` from `.squad/config.json`
78
+ 2. ACKNOWLEDGE: `✅ Model preference cleared — returning to automatic selection.`
79
+
80
+ ### STOP
81
+
82
+ After resolving the model and including it in the spawn template, this skill is done. Do NOT:
83
+ - Generate model comparison reports
84
+ - Run benchmarks or speed tests
85
+ - Create new config files (only modify existing `.squad/config.json`)
86
+ - Change the model after spawn (fallback chains handle runtime failures)
87
+
88
+ ## Config Schema
89
+
90
+ `.squad/config.json` model-related fields:
91
+
92
+ ```json
93
+ {
94
+ "version": 1,
95
+ "defaultModel": "claude-opus-4.6",
96
+ "agentModelOverrides": {
97
+ "fenster": "claude-sonnet-4.6",
98
+ "mcmanus": "claude-haiku-4.5"
99
+ }
100
+ }
101
+ ```
102
+
103
+ - `defaultModel` — applies to ALL agents unless overridden by `agentModelOverrides`
104
+ - `agentModelOverrides` — per-agent overrides that take priority over `defaultModel`
105
+ - Both fields are optional. When absent, Layers 1-4 apply normally.
106
+
107
+ ## Fallback Chains
108
+
109
+ If a model is unavailable (rate limit, plan restriction), retry within the same tier:
110
+
111
+ ```
112
+ Premium: claude-opus-4.6 → claude-opus-4.6-fast → claude-opus-4.5 → claude-sonnet-4.6
113
+ Standard: claude-sonnet-4.6 → gpt-5.4 → claude-sonnet-4.5 → gpt-5.3-codex → claude-sonnet-4
114
+ Fast: claude-haiku-4.5 → gpt-5.1-codex-mini → gpt-4.1 → gpt-5-mini
115
+ ```
116
+
117
+ **Never fall UP in tier.** A fast task won't land on a premium model via fallback.
@@ -1,24 +1,24 @@
1
- # Skill: nap
2
-
3
- > Context hygiene — compress, prune, archive .squad/ state
4
-
5
- ## What It Does
6
-
7
- Reclaims context window budget by compressing agent histories, pruning old logs,
8
- archiving stale decisions, and cleaning orphaned inbox files.
9
-
10
- ## When To Use
11
-
12
- - Before heavy fan-out work (many agents will spawn)
13
- - When history.md files exceed 15KB
14
- - When .squad/ total size exceeds 1MB
15
- - After long-running sessions or sprints
16
-
17
- ## Invocation
18
-
19
- - CLI: `squad nap` / `squad nap --deep` / `squad nap --dry-run`
20
- - REPL: `/nap` / `/nap --dry-run` / `/nap --deep`
21
-
22
- ## Confidence
23
-
24
- medium — Confirmed by team vote (4-1) and initial implementation
1
+ # Skill: nap
2
+
3
+ > Context hygiene — compress, prune, archive .squad/ state
4
+
5
+ ## What It Does
6
+
7
+ Reclaims context window budget by compressing agent histories, pruning old logs,
8
+ archiving stale decisions, and cleaning orphaned inbox files.
9
+
10
+ ## When To Use
11
+
12
+ - Before heavy fan-out work (many agents will spawn)
13
+ - When history.md files exceed 15KB
14
+ - When .squad/ total size exceeds 1MB
15
+ - After long-running sessions or sprints
16
+
17
+ ## Invocation
18
+
19
+ - CLI: `squad nap` / `squad nap --deep` / `squad nap --dry-run`
20
+ - REPL: `/nap` / `/nap --dry-run` / `/nap --deep`
21
+
22
+ ## Confidence
23
+
24
+ medium — Confirmed by team vote (4-1) and initial implementation
@@ -1,57 +1,57 @@
1
- # Personal Squad — Skill Document
2
-
3
- ## What is a Personal Squad?
4
-
5
- A personal squad is a user-level collection of AI agents that travel with you across projects. Unlike project agents (defined in a project's `.squad/` directory), personal agents live in your global config directory and are automatically discovered when you start a squad session.
6
-
7
- ## Directory Structure
8
-
9
- ```
10
- ~/.config/squad/personal-squad/ # Linux/macOS
11
- %APPDATA%/squad/personal-squad/ # Windows
12
- ├── agents/
13
- │ ├── {agent-name}/
14
- │ │ ├── charter.md
15
- │ │ └── history.md
16
- │ └── ...
17
- └── config.json # Optional: personal squad config
18
- ```
19
-
20
- ## How It Works
21
-
22
- 1. **Ambient Discovery:** When Squad starts a session, it checks for a personal squad directory
23
- 2. **Merge:** Personal agents are merged into the session cast alongside project agents
24
- 3. **Ghost Protocol:** Personal agents can read project state but not write to it
25
- 4. **Kill Switch:** Set `SQUAD_NO_PERSONAL=1` to disable ambient discovery
26
-
27
- ## Commands
28
-
29
- - `squad personal init` — Bootstrap a personal squad directory
30
- - `squad personal list` — List your personal agents
31
- - `squad personal add {name} --role {role}` — Add a personal agent
32
- - `squad personal remove {name}` — Remove a personal agent
33
- - `squad cast` — Show the current session cast (project + personal)
34
-
35
- ## Ghost Protocol
36
-
37
- See `templates/ghost-protocol.md` for the full rules. Key points:
38
- - Personal agents advise; project agents execute
39
- - No writes to project `.squad/` state
40
- - Transparent origin tagging in logs
41
- - Project agents take precedence on conflicts
42
-
43
- ## Configuration
44
-
45
- Optional `config.json` in the personal squad directory:
46
- ```json
47
- {
48
- "defaultModel": "auto",
49
- "ghostProtocol": true,
50
- "agents": {}
51
- }
52
- ```
53
-
54
- ## Environment Variables
55
-
56
- - `SQUAD_NO_PERSONAL` — Set to any value to disable personal squad discovery
57
- - `SQUAD_PERSONAL_DIR` — Override the default personal squad directory path
1
+ # Personal Squad — Skill Document
2
+
3
+ ## What is a Personal Squad?
4
+
5
+ A personal squad is a user-level collection of AI agents that travel with you across projects. Unlike project agents (defined in a project's `.squad/` directory), personal agents live in your global config directory and are automatically discovered when you start a squad session.
6
+
7
+ ## Directory Structure
8
+
9
+ ```
10
+ ~/.config/squad/personal-squad/ # Linux/macOS
11
+ %APPDATA%/squad/personal-squad/ # Windows
12
+ ├── agents/
13
+ │ ├── {agent-name}/
14
+ │ │ ├── charter.md
15
+ │ │ └── history.md
16
+ │ └── ...
17
+ └── config.json # Optional: personal squad config
18
+ ```
19
+
20
+ ## How It Works
21
+
22
+ 1. **Ambient Discovery:** When Squad starts a session, it checks for a personal squad directory
23
+ 2. **Merge:** Personal agents are merged into the session cast alongside project agents
24
+ 3. **Ghost Protocol:** Personal agents can read project state but not write to it
25
+ 4. **Kill Switch:** Set `SQUAD_NO_PERSONAL=1` to disable ambient discovery
26
+
27
+ ## Commands
28
+
29
+ - `squad personal init` — Bootstrap a personal squad directory
30
+ - `squad personal list` — List your personal agents
31
+ - `squad personal add {name} --role {role}` — Add a personal agent
32
+ - `squad personal remove {name}` — Remove a personal agent
33
+ - `squad cast` — Show the current session cast (project + personal)
34
+
35
+ ## Ghost Protocol
36
+
37
+ See `templates/ghost-protocol.md` for the full rules. Key points:
38
+ - Personal agents advise; project agents execute
39
+ - No writes to project `.squad/` state
40
+ - Transparent origin tagging in logs
41
+ - Project agents take precedence on conflicts
42
+
43
+ ## Configuration
44
+
45
+ Optional `config.json` in the personal squad directory:
46
+ ```json
47
+ {
48
+ "defaultModel": "auto",
49
+ "ghostProtocol": true,
50
+ "agents": {}
51
+ }
52
+ ```
53
+
54
+ ## Environment Variables
55
+
56
+ - `SQUAD_NO_PERSONAL` — Set to any value to disable personal squad discovery
57
+ - `SQUAD_PERSONAL_DIR` — Override the default personal squad directory path
@@ -1,56 +1,56 @@
1
- ---
2
- name: "project-conventions"
3
- description: "Core conventions and patterns for this codebase"
4
- domain: "project-conventions"
5
- confidence: "medium"
6
- source: "template"
7
- ---
8
-
9
- ## Context
10
-
11
- > **This is a starter template.** Replace the placeholder patterns below with your actual project conventions. Skills train agents on codebase-specific practices — accurate documentation here improves agent output quality.
12
-
13
- ## Patterns
14
-
15
- ### [Pattern Name]
16
-
17
- Describe a key convention or practice used in this codebase. Be specific about what to do and why.
18
-
19
- ### Error Handling
20
-
21
- <!-- Example: How does your project handle errors? -->
22
- <!-- - Use try/catch with specific error types? -->
23
- <!-- - Log to a specific service? -->
24
- <!-- - Return error objects vs throwing? -->
25
-
26
- ### Testing
27
-
28
- <!-- Example: What test framework? Where do tests live? How to run them? -->
29
- <!-- - Test framework: Jest/Vitest/node:test/etc. -->
30
- <!-- - Test location: test/, __tests__/, *.test.ts, etc. -->
31
- <!-- - Run command: npm test, etc. -->
32
-
33
- ### Code Style
34
-
35
- <!-- Example: Linting, formatting, naming conventions -->
36
- <!-- - Linter: ESLint config? -->
37
- <!-- - Formatter: Prettier? -->
38
- <!-- - Naming: camelCase, snake_case, etc.? -->
39
-
40
- ### File Structure
41
-
42
- <!-- Example: How is the project organized? -->
43
- <!-- - src/ — Source code -->
44
- <!-- - test/ — Tests -->
45
- <!-- - docs/ — Documentation -->
46
-
47
- ## Examples
48
-
49
- ```
50
- // Add code examples that demonstrate your conventions
51
- ```
52
-
53
- ## Anti-Patterns
54
-
55
- <!-- List things to avoid in this codebase -->
56
- - **[Anti-pattern]** — Explanation of what not to do and why.
1
+ ---
2
+ name: "project-conventions"
3
+ description: "Core conventions and patterns for this codebase"
4
+ domain: "project-conventions"
5
+ confidence: "medium"
6
+ source: "template"
7
+ ---
8
+
9
+ ## Context
10
+
11
+ > **This is a starter template.** Replace the placeholder patterns below with your actual project conventions. Skills train agents on codebase-specific practices — accurate documentation here improves agent output quality.
12
+
13
+ ## Patterns
14
+
15
+ ### [Pattern Name]
16
+
17
+ Describe a key convention or practice used in this codebase. Be specific about what to do and why.
18
+
19
+ ### Error Handling
20
+
21
+ <!-- Example: How does your project handle errors? -->
22
+ <!-- - Use try/catch with specific error types? -->
23
+ <!-- - Log to a specific service? -->
24
+ <!-- - Return error objects vs throwing? -->
25
+
26
+ ### Testing
27
+
28
+ <!-- Example: What test framework? Where do tests live? How to run them? -->
29
+ <!-- - Test framework: Jest/Vitest/node:test/etc. -->
30
+ <!-- - Test location: test/, __tests__/, *.test.ts, etc. -->
31
+ <!-- - Run command: npm test, etc. -->
32
+
33
+ ### Code Style
34
+
35
+ <!-- Example: Linting, formatting, naming conventions -->
36
+ <!-- - Linter: ESLint config? -->
37
+ <!-- - Formatter: Prettier? -->
38
+ <!-- - Naming: camelCase, snake_case, etc.? -->
39
+
40
+ ### File Structure
41
+
42
+ <!-- Example: How is the project organized? -->
43
+ <!-- - src/ — Source code -->
44
+ <!-- - test/ — Tests -->
45
+ <!-- - docs/ — Documentation -->
46
+
47
+ ## Examples
48
+
49
+ ```
50
+ // Add code examples that demonstrate your conventions
51
+ ```
52
+
53
+ ## Anti-Patterns
54
+
55
+ <!-- List things to avoid in this codebase -->
56
+ - **[Anti-pattern]** — Explanation of what not to do and why.