azcodr 1.5.0 → 1.5.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/.agents/hooks.json +42 -0
- package/.agents/hooks.json.example +42 -42
- package/.agents/mcp_config.json.example +29 -24
- package/.agents/scripts/safety_guard.sh +34 -16
- package/.agents/scripts/verify_completion.sh +27 -13
- package/.agents/skills/agentic-architect/SKILL.md +125 -125
- package/.agents/skills/agentic-architect/references/agents_md_template.md +62 -62
- package/.agents/skills/agentic-architect/references/refinement_workflow.md +32 -32
- package/.agents/skills/agentic-architect/references/skill_architecture_inquiry.md +63 -63
- package/.agents/skills/agentic-architect/references/skill_template.md +56 -56
- package/.agents/skills/agentic-architect/scripts/validate_agentic_configs.sh +402 -362
- package/.agents/skills/clean-code-refactor/SKILL.md +91 -91
- package/.agents/skills/clean-code-refactor/references/clean_code_smells.md +27 -27
- package/.agents/skills/clean-code-refactor/references/design_patterns_ts.md +65 -65
- package/.agents/skills/compliance-audit/SKILL.md +120 -120
- package/.agents/skills/compliance-audit/references/owasp_top10_controls.md +16 -16
- package/.agents/skills/compliance-audit/references/soc2_iso_controls.md +28 -28
- package/.agents/skills/lets-build/SKILL.md +173 -172
- package/.agents/skills/lets-build/references/architecture_interview_matrix.md +115 -115
- package/.agents/skills/lets-build/references/hexagonal_bootstrap_scaffolds.md +160 -160
- package/.agents/skills/lets-build/references/project_readme_template.md +79 -79
- package/.agents/skills/lets-build/scripts/bootstrap_workspace.sh +255 -253
- package/.agents/skills/product-analyst/SKILL.md +154 -154
- package/.agents/skills/product-analyst/references/backlog_ordering_techniques.md +107 -107
- package/.agents/skills/product-analyst/references/gherkin_patterns.md +46 -46
- package/.agents/skills/product-analyst/references/invest_checklist.md +38 -38
- package/.agents/skills/product-analyst/references/okr_alignment_guide.md +76 -76
- package/.agents/skills/product-analyst/references/smart_tasks.md +59 -59
- package/.agents/skills/relentless-questioner/SKILL.md +128 -128
- package/.agents/skills/relentless-questioner/references/adaptive_question_trees.md +102 -102
- package/.editorconfig +19 -19
- package/.github/copilot-instructions.md +1 -0
- package/.github/workflows/ci.yml +78 -0
- package/.gitignore +25 -25
- package/AGENTS.md +102 -102
- package/LICENSE +21 -21
- package/README.md +165 -154
- package/bin/azcodr.js +228 -228
- package/data/.gitkeep +0 -0
- package/docs/knowledge/ubiquitous_language.md +18 -18
- package/docs/rules/agentic_configuration.md +259 -259
- package/docs/rules/api_architecture.md +179 -179
- package/docs/rules/authentication.md +76 -76
- package/docs/rules/authorization.md +75 -75
- package/docs/rules/caching.md +69 -69
- package/docs/rules/clean_code.md +62 -62
- package/docs/rules/cloud_native.md +41 -41
- package/docs/rules/cqrs.md +203 -203
- package/docs/rules/database_design.md +125 -125
- package/docs/rules/database_operations.md +69 -69
- package/docs/rules/design_patterns.md +98 -98
- package/docs/rules/devops_ci_cd.md +76 -76
- package/docs/rules/domain_driven_design.md +122 -122
- package/docs/rules/error_handling.md +52 -52
- package/docs/rules/feature_flags.md +59 -59
- package/docs/rules/frontend_architecture.md +157 -157
- package/docs/rules/multitenancy_architecture.md +98 -98
- package/docs/rules/product_ownership.md +127 -127
- package/docs/rules/project_management.md +49 -49
- package/docs/rules/relentless_questioning.md +52 -52
- package/docs/rules/requirements_engineering.md +98 -98
- package/docs/rules/security_compliance.md +53 -53
- package/docs/rules/server_driven_ui.md +88 -88
- package/docs/rules/test_driven_development.md +185 -185
- package/docs/rules/transactional_email.md +27 -27
- package/docs/rules/type_safety.md +65 -65
- package/docs/rules/ui_ux_architecture.md +150 -150
- package/docs/rules/workflow_state_machines.md +117 -117
- package/lib/index.d.ts +134 -123
- package/lib/index.js +5 -5
- package/lib/scaffold.js +448 -351
- package/memory.md +36 -36
- package/package.json +62 -59
- package/scripts/test_coverage.js +38 -0
- package/scripts/validate.js +258 -0
|
@@ -1,62 +1,62 @@
|
|
|
1
|
-
# Root & Nested AGENTS.md Template
|
|
2
|
-
|
|
3
|
-
Use this template when bootstrapping or restructuring an `AGENTS.md` file according to the progressive disclosure architecture.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
```markdown
|
|
8
|
-
# AGENTS.md
|
|
9
|
-
|
|
10
|
-
> **[Workspace / Package Name] Directives**
|
|
11
|
-
> **Rule Zero:** Assume nothing. Every action must be grounded in verified evidence from this workspace or direct instructions from the user.
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## 1. Project Overview & Environment
|
|
16
|
-
- **Purpose:** [1–2 sentences explaining what this project does and its core domain].
|
|
17
|
-
- **Runtime & Tools:** [e.g. Node 24 / npm 11, package manager, key global scripts].
|
|
18
|
-
- **High-Level Layout:**
|
|
19
|
-
- `apps/` — [High-level package boundaries].
|
|
20
|
-
- `packages/` — [Shared libraries/utilities].
|
|
21
|
-
- `docs/rules/` — [Modular progressive disclosure rules].
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## 2. Core Operating Framework
|
|
26
|
-
- **Ground Truth Only:** A statement is only true if proven by a file, command output, or direct user instruction.
|
|
27
|
-
- **Relentless Questioning Loop:** Before acting, answer:
|
|
28
|
-
1. What is current state?
|
|
29
|
-
2. What is exact goal?
|
|
30
|
-
3. What tools are available?
|
|
31
|
-
4. What could break?
|
|
32
|
-
5. How will we prove it works?
|
|
33
|
-
- **Execution Stages:** `DISCOVER` ➔ `INTERROGATE` ➔ `PLAN` ➔ `EXECUTE` ➔ `VERIFY`.
|
|
34
|
-
- **Action Boundaries:**
|
|
35
|
-
- **ALWAYS:** Read before editing; verify commands before running; verify results with evidence.
|
|
36
|
-
- **ASK FIRST:** Adding dependencies, deleting files, modifying DB schemas or existing tests.
|
|
37
|
-
- **NEVER:** Guess paths or flags; silently ignore errors; import external assumptions.
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## 3. Progressive Disclosure Rules
|
|
42
|
-
|
|
43
|
-
Read these specialized rule files on demand when performing relevant tasks:
|
|
44
|
-
|
|
45
|
-
| Domain | Rule Reference File | When to Consult |
|
|
46
|
-
|---|---|---|
|
|
47
|
-
| **Testing** | [docs/rules/test_driven_development.md](../../../../docs/rules/test_driven_development.md) | Writing acceptance/unit tests, coverage checks. |
|
|
48
|
-
| **Multi-Tenancy** | [docs/rules/multitenancy_architecture.md](../../../../docs/rules/multitenancy_architecture.md) | Tenant context resolution, PostgreSQL RLS. |
|
|
49
|
-
| **Database** | [docs/rules/database_design.md](../../../../docs/rules/database_design.md) | Relational integrity, ACID transactions, outbox pattern. |
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
## 4. Harness Parity
|
|
54
|
-
Keep `AGENTS.md`, `CLAUDE.md`, `agents.md`, `GEMINI.md`, `.cursorrules`, and `.windsurfrules` in sync via filesystem symlinks:
|
|
55
|
-
```bash
|
|
56
|
-
ln -sf AGENTS.md CLAUDE.md
|
|
57
|
-
ln -sf AGENTS.md agents.md
|
|
58
|
-
ln -sf AGENTS.md GEMINI.md
|
|
59
|
-
ln -sf AGENTS.md .cursorrules
|
|
60
|
-
ln -sf AGENTS.md .windsurfrules
|
|
61
|
-
```
|
|
62
|
-
```
|
|
1
|
+
# Root & Nested AGENTS.md Template
|
|
2
|
+
|
|
3
|
+
Use this template when bootstrapping or restructuring an `AGENTS.md` file according to the progressive disclosure architecture.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# AGENTS.md
|
|
9
|
+
|
|
10
|
+
> **[Workspace / Package Name] Directives**
|
|
11
|
+
> **Rule Zero:** Assume nothing. Every action must be grounded in verified evidence from this workspace or direct instructions from the user.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 1. Project Overview & Environment
|
|
16
|
+
- **Purpose:** [1–2 sentences explaining what this project does and its core domain].
|
|
17
|
+
- **Runtime & Tools:** [e.g. Node 24 / npm 11, package manager, key global scripts].
|
|
18
|
+
- **High-Level Layout:**
|
|
19
|
+
- `apps/` — [High-level package boundaries].
|
|
20
|
+
- `packages/` — [Shared libraries/utilities].
|
|
21
|
+
- `docs/rules/` — [Modular progressive disclosure rules].
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 2. Core Operating Framework
|
|
26
|
+
- **Ground Truth Only:** A statement is only true if proven by a file, command output, or direct user instruction.
|
|
27
|
+
- **Relentless Questioning Loop:** Before acting, answer:
|
|
28
|
+
1. What is current state?
|
|
29
|
+
2. What is exact goal?
|
|
30
|
+
3. What tools are available?
|
|
31
|
+
4. What could break?
|
|
32
|
+
5. How will we prove it works?
|
|
33
|
+
- **Execution Stages:** `DISCOVER` ➔ `INTERROGATE` ➔ `PLAN` ➔ `EXECUTE` ➔ `VERIFY`.
|
|
34
|
+
- **Action Boundaries:**
|
|
35
|
+
- **ALWAYS:** Read before editing; verify commands before running; verify results with evidence.
|
|
36
|
+
- **ASK FIRST:** Adding dependencies, deleting files, modifying DB schemas or existing tests.
|
|
37
|
+
- **NEVER:** Guess paths or flags; silently ignore errors; import external assumptions.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 3. Progressive Disclosure Rules
|
|
42
|
+
|
|
43
|
+
Read these specialized rule files on demand when performing relevant tasks:
|
|
44
|
+
|
|
45
|
+
| Domain | Rule Reference File | When to Consult |
|
|
46
|
+
|---|---|---|
|
|
47
|
+
| **Testing** | [docs/rules/test_driven_development.md](../../../../docs/rules/test_driven_development.md) | Writing acceptance/unit tests, coverage checks. |
|
|
48
|
+
| **Multi-Tenancy** | [docs/rules/multitenancy_architecture.md](../../../../docs/rules/multitenancy_architecture.md) | Tenant context resolution, PostgreSQL RLS. |
|
|
49
|
+
| **Database** | [docs/rules/database_design.md](../../../../docs/rules/database_design.md) | Relational integrity, ACID transactions, outbox pattern. |
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## 4. Harness Parity
|
|
54
|
+
Keep `AGENTS.md`, `CLAUDE.md`, `agents.md`, `GEMINI.md`, `.cursorrules`, and `.windsurfrules` in sync via filesystem symlinks:
|
|
55
|
+
```bash
|
|
56
|
+
ln -sf AGENTS.md CLAUDE.md
|
|
57
|
+
ln -sf AGENTS.md agents.md
|
|
58
|
+
ln -sf AGENTS.md GEMINI.md
|
|
59
|
+
ln -sf AGENTS.md .cursorrules
|
|
60
|
+
ln -sf AGENTS.md .windsurfrules
|
|
61
|
+
```
|
|
62
|
+
```
|
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
# Continuous Skill & Rule Refinement Workflow
|
|
2
|
-
|
|
3
|
-
> **Purpose:** Iteratively improve AI code output by harvesting manual developer edits and converting recurring mistakes into explicit skill rules.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## The 4-Step Refinement Loop
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
1. AI Draft Generated ──► 2. Human Manual Edit ──► 3. Extract Gaps & Anti-Patterns ──► 4. Update Skill
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
### 1. Capture Raw Output
|
|
14
|
-
When prompting the AI to execute a complex task (e.g. drafting an article, building a complex form, scaffolding an endpoint), retain the raw generated output before making edits.
|
|
15
|
-
|
|
16
|
-
### 2. Perform Gold-Standard Edits
|
|
17
|
-
Manually modify the generated file to match production quality:
|
|
18
|
-
- Adjust architectural choices.
|
|
19
|
-
- Fix styling, accessibility, or type annotations.
|
|
20
|
-
- Correct API response shapes or error handling.
|
|
21
|
-
|
|
22
|
-
### 3. Analyze the Diff
|
|
23
|
-
Compare the initial AI draft against the final human version:
|
|
24
|
-
- What did the AI assume that was incorrect?
|
|
25
|
-
- What repetitive boilerplate did the AI miss?
|
|
26
|
-
- What unnecessary packages, methods, or complex patterns did it introduce?
|
|
27
|
-
|
|
28
|
-
### 4. Feed Back into the Skill
|
|
29
|
-
Update the relevant skill or rule file:
|
|
30
|
-
- Add positive examples under the workflow section.
|
|
31
|
-
- **Crucial:** Add explicit negative rules in the **"Gotchas & What NOT to Do"** section (e.g. *"DO NOT use window.confirm; use @radix-ui/react-alert-dialog"*).
|
|
32
|
-
- If a step failed due to non-deterministic CLI flags, write an executable helper script under `scripts/`.
|
|
1
|
+
# Continuous Skill & Rule Refinement Workflow
|
|
2
|
+
|
|
3
|
+
> **Purpose:** Iteratively improve AI code output by harvesting manual developer edits and converting recurring mistakes into explicit skill rules.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## The 4-Step Refinement Loop
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
1. AI Draft Generated ──► 2. Human Manual Edit ──► 3. Extract Gaps & Anti-Patterns ──► 4. Update Skill
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### 1. Capture Raw Output
|
|
14
|
+
When prompting the AI to execute a complex task (e.g. drafting an article, building a complex form, scaffolding an endpoint), retain the raw generated output before making edits.
|
|
15
|
+
|
|
16
|
+
### 2. Perform Gold-Standard Edits
|
|
17
|
+
Manually modify the generated file to match production quality:
|
|
18
|
+
- Adjust architectural choices.
|
|
19
|
+
- Fix styling, accessibility, or type annotations.
|
|
20
|
+
- Correct API response shapes or error handling.
|
|
21
|
+
|
|
22
|
+
### 3. Analyze the Diff
|
|
23
|
+
Compare the initial AI draft against the final human version:
|
|
24
|
+
- What did the AI assume that was incorrect?
|
|
25
|
+
- What repetitive boilerplate did the AI miss?
|
|
26
|
+
- What unnecessary packages, methods, or complex patterns did it introduce?
|
|
27
|
+
|
|
28
|
+
### 4. Feed Back into the Skill
|
|
29
|
+
Update the relevant skill or rule file:
|
|
30
|
+
- Add positive examples under the workflow section.
|
|
31
|
+
- **Crucial:** Add explicit negative rules in the **"Gotchas & What NOT to Do"** section (e.g. *"DO NOT use window.confirm; use @radix-ui/react-alert-dialog"*).
|
|
32
|
+
- If a step failed due to non-deterministic CLI flags, write an executable helper script under `scripts/`.
|
|
@@ -1,63 +1,63 @@
|
|
|
1
|
-
# Relentless Skill Architecture Inquiry Guide
|
|
2
|
-
|
|
3
|
-
> **Core Rule:** Never assume what a skill needs. Relentlessly interrogate all 7 branches before authoring or modifying any `SKILL.md`.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## The 7 Core Inquiry Branches
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
[Skill Request / Idea]
|
|
11
|
-
│
|
|
12
|
-
▼
|
|
13
|
-
[Branch 1: Placement & Scope]
|
|
14
|
-
├─ All prompts repository-wide? ─────────► Root AGENTS.md
|
|
15
|
-
├─ One monorepo package only? ──────────► Nested package AGENTS.md
|
|
16
|
-
├─ Continuous domain coding rule? ──────► docs/rules/*.md
|
|
17
|
-
└─ Specialized on-demand workflow? ─────► .agents/skills/<name>/
|
|
18
|
-
│
|
|
19
|
-
▼
|
|
20
|
-
[Branch 2: Trigger Intent & Anti-Triggers]
|
|
21
|
-
├─ What explicit user request triggers this?
|
|
22
|
-
├─ Imperative phrasing: 'Use when the user wants to...' (< 1024 chars)
|
|
23
|
-
└─ Negative boundaries: 'Do NOT use for...'
|
|
24
|
-
│
|
|
25
|
-
▼
|
|
26
|
-
[Branch 3: Domain Ground Truth (Purge Fluff)]
|
|
27
|
-
├─ What does the LLM already know from pre-training? (PURGE)
|
|
28
|
-
└─ What is strictly proprietary/unique to this repository? (KEEP)
|
|
29
|
-
│
|
|
30
|
-
▼
|
|
31
|
-
[Branch 4: Anti-Patterns & Gotchas (What NOT to Do)]
|
|
32
|
-
├─ What mistakes has the AI actually made in past attempts?
|
|
33
|
-
└─ Formulate 3–5 explicit negative constraints ('DO NOT...')
|
|
34
|
-
│
|
|
35
|
-
▼
|
|
36
|
-
[Branch 5: Determinism vs. Stochastic LLM]
|
|
37
|
-
├─ Are there brittle command lines or JSON formatting steps?
|
|
38
|
-
└─ Should these be deterministic helper scripts in scripts/?
|
|
39
|
-
│
|
|
40
|
-
▼
|
|
41
|
-
[Branch 6: Progressive Disclosure (< 500 Lines)]
|
|
42
|
-
├─ Is SKILL.md under 500 lines?
|
|
43
|
-
├─ Are deep manuals offloaded to references/?
|
|
44
|
-
└─ Are static schemas or templates offloaded to resources/?
|
|
45
|
-
│
|
|
46
|
-
▼
|
|
47
|
-
[Branch 7: Verification & Feedback Loop]
|
|
48
|
-
├─ What structured output format proves success?
|
|
49
|
-
├─ What self-validation checklist must be satisfied?
|
|
50
|
-
└─ How will diffs between AI drafts and human edits be harvested?
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Inquiry Interview Template
|
|
56
|
-
|
|
57
|
-
When asking the user or interrogating the workspace, use this questionnaire:
|
|
58
|
-
|
|
59
|
-
1. **Scope:** Is this workflow continuous (applies whenever writing code in this domain) or episodic (triggered only on explicit request)?
|
|
60
|
-
2. **Triggers:** When should the AI automatically reach for this skill? What tasks should it actively *refuse* to use this skill for?
|
|
61
|
-
3. **Pitfalls:** What has the AI historically messed up when doing this task (e.g. hallucinating dependencies, using wrong flags, creating leaky abstractions)?
|
|
62
|
-
4. **Determinism:** Are there shell commands or formatting rules that should be guaranteed with a script rather than left to LLM chance?
|
|
63
|
-
5. **Output Standard:** What does the ideal, gold-standard output look like?
|
|
1
|
+
# Relentless Skill Architecture Inquiry Guide
|
|
2
|
+
|
|
3
|
+
> **Core Rule:** Never assume what a skill needs. Relentlessly interrogate all 7 branches before authoring or modifying any `SKILL.md`.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## The 7 Core Inquiry Branches
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
[Skill Request / Idea]
|
|
11
|
+
│
|
|
12
|
+
▼
|
|
13
|
+
[Branch 1: Placement & Scope]
|
|
14
|
+
├─ All prompts repository-wide? ─────────► Root AGENTS.md
|
|
15
|
+
├─ One monorepo package only? ──────────► Nested package AGENTS.md
|
|
16
|
+
├─ Continuous domain coding rule? ──────► docs/rules/*.md
|
|
17
|
+
└─ Specialized on-demand workflow? ─────► .agents/skills/<name>/
|
|
18
|
+
│
|
|
19
|
+
▼
|
|
20
|
+
[Branch 2: Trigger Intent & Anti-Triggers]
|
|
21
|
+
├─ What explicit user request triggers this?
|
|
22
|
+
├─ Imperative phrasing: 'Use when the user wants to...' (< 1024 chars)
|
|
23
|
+
└─ Negative boundaries: 'Do NOT use for...'
|
|
24
|
+
│
|
|
25
|
+
▼
|
|
26
|
+
[Branch 3: Domain Ground Truth (Purge Fluff)]
|
|
27
|
+
├─ What does the LLM already know from pre-training? (PURGE)
|
|
28
|
+
└─ What is strictly proprietary/unique to this repository? (KEEP)
|
|
29
|
+
│
|
|
30
|
+
▼
|
|
31
|
+
[Branch 4: Anti-Patterns & Gotchas (What NOT to Do)]
|
|
32
|
+
├─ What mistakes has the AI actually made in past attempts?
|
|
33
|
+
└─ Formulate 3–5 explicit negative constraints ('DO NOT...')
|
|
34
|
+
│
|
|
35
|
+
▼
|
|
36
|
+
[Branch 5: Determinism vs. Stochastic LLM]
|
|
37
|
+
├─ Are there brittle command lines or JSON formatting steps?
|
|
38
|
+
└─ Should these be deterministic helper scripts in scripts/?
|
|
39
|
+
│
|
|
40
|
+
▼
|
|
41
|
+
[Branch 6: Progressive Disclosure (< 500 Lines)]
|
|
42
|
+
├─ Is SKILL.md under 500 lines?
|
|
43
|
+
├─ Are deep manuals offloaded to references/?
|
|
44
|
+
└─ Are static schemas or templates offloaded to resources/?
|
|
45
|
+
│
|
|
46
|
+
▼
|
|
47
|
+
[Branch 7: Verification & Feedback Loop]
|
|
48
|
+
├─ What structured output format proves success?
|
|
49
|
+
├─ What self-validation checklist must be satisfied?
|
|
50
|
+
└─ How will diffs between AI drafts and human edits be harvested?
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Inquiry Interview Template
|
|
56
|
+
|
|
57
|
+
When asking the user or interrogating the workspace, use this questionnaire:
|
|
58
|
+
|
|
59
|
+
1. **Scope:** Is this workflow continuous (applies whenever writing code in this domain) or episodic (triggered only on explicit request)?
|
|
60
|
+
2. **Triggers:** When should the AI automatically reach for this skill? What tasks should it actively *refuse* to use this skill for?
|
|
61
|
+
3. **Pitfalls:** What has the AI historically messed up when doing this task (e.g. hallucinating dependencies, using wrong flags, creating leaky abstractions)?
|
|
62
|
+
4. **Determinism:** Are there shell commands or formatting rules that should be guaranteed with a script rather than left to LLM chance?
|
|
63
|
+
5. **Output Standard:** What does the ideal, gold-standard output look like?
|
|
@@ -1,56 +1,56 @@
|
|
|
1
|
-
# Progressive Disclosure Skill Template
|
|
2
|
-
|
|
3
|
-
Use this template when creating new skills under `.agents/skills/<skill-name>/SKILL.md`.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
```markdown
|
|
8
|
-
---
|
|
9
|
-
name: <skill-name>
|
|
10
|
-
description: Use when [clear trigger conditions, e.g. implementing authentication, generating emails, running migrations]. Do not use for [explicit boundaries, e.g. general bug fixes or frontend styling].
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
# [Skill Title]
|
|
14
|
-
|
|
15
|
-
> **Purpose:** [Brief 1–2 sentence summary of what this skill achieves].
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## 1. Trigger Conditions
|
|
20
|
-
- When the user explicitly requests: `[Examples]`
|
|
21
|
-
- When performing tasks involving: `[File patterns or domains]`
|
|
22
|
-
- **Do NOT trigger when:** `[Negative conditions]`
|
|
23
|
-
|
|
24
|
-
---
|
|
25
|
-
|
|
26
|
-
## 2. Core Workflow Steps
|
|
27
|
-
1. **[Step 1: Discover & Validate]**: Inspect current state before modifying code.
|
|
28
|
-
2. **[Step 2: Execute Core Logic]**: Follow established patterns.
|
|
29
|
-
3. **[Step 3: Self-Check & Verify]**: Run test commands or validation scripts.
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
## 3. Gotchas & What NOT to Do
|
|
34
|
-
- **DO NOT** [Specific common AI mistake #1].
|
|
35
|
-
- **DO NOT** [Specific common AI mistake #2].
|
|
36
|
-
- **DO NOT** [Specific common AI mistake #3].
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## 4. Structured Output Template
|
|
41
|
-
Provide consistent formatting for results:
|
|
42
|
-
```markdown
|
|
43
|
-
### Summary of Changes
|
|
44
|
-
- **Action**: ...
|
|
45
|
-
- **Files Affected**: ...
|
|
46
|
-
- **Verification Evidence**: ...
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## 5. Subdirectories & Progressive Resources
|
|
52
|
-
- Deep reference documentation: `references/`
|
|
53
|
-
- Deterministic helper scripts: `scripts/`
|
|
54
|
-
- Static schemas, templates, or mock data: `resources/`
|
|
55
|
-
- Reference implementations and patterns: `examples/`
|
|
56
|
-
```
|
|
1
|
+
# Progressive Disclosure Skill Template
|
|
2
|
+
|
|
3
|
+
Use this template when creating new skills under `.agents/skills/<skill-name>/SKILL.md`.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
---
|
|
9
|
+
name: <skill-name>
|
|
10
|
+
description: Use when [clear trigger conditions, e.g. implementing authentication, generating emails, running migrations]. Do not use for [explicit boundaries, e.g. general bug fixes or frontend styling].
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# [Skill Title]
|
|
14
|
+
|
|
15
|
+
> **Purpose:** [Brief 1–2 sentence summary of what this skill achieves].
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 1. Trigger Conditions
|
|
20
|
+
- When the user explicitly requests: `[Examples]`
|
|
21
|
+
- When performing tasks involving: `[File patterns or domains]`
|
|
22
|
+
- **Do NOT trigger when:** `[Negative conditions]`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 2. Core Workflow Steps
|
|
27
|
+
1. **[Step 1: Discover & Validate]**: Inspect current state before modifying code.
|
|
28
|
+
2. **[Step 2: Execute Core Logic]**: Follow established patterns.
|
|
29
|
+
3. **[Step 3: Self-Check & Verify]**: Run test commands or validation scripts.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 3. Gotchas & What NOT to Do
|
|
34
|
+
- **DO NOT** [Specific common AI mistake #1].
|
|
35
|
+
- **DO NOT** [Specific common AI mistake #2].
|
|
36
|
+
- **DO NOT** [Specific common AI mistake #3].
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 4. Structured Output Template
|
|
41
|
+
Provide consistent formatting for results:
|
|
42
|
+
```markdown
|
|
43
|
+
### Summary of Changes
|
|
44
|
+
- **Action**: ...
|
|
45
|
+
- **Files Affected**: ...
|
|
46
|
+
- **Verification Evidence**: ...
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## 5. Subdirectories & Progressive Resources
|
|
52
|
+
- Deep reference documentation: `references/`
|
|
53
|
+
- Deterministic helper scripts: `scripts/`
|
|
54
|
+
- Static schemas, templates, or mock data: `resources/`
|
|
55
|
+
- Reference implementations and patterns: `examples/`
|
|
56
|
+
```
|