UNPKG

@zeix/cause-effect

Version:

Cause & Effect - reactive state management primitives library for TypeScript.

84 lines (65 loc) • 2.86 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
--- name: adr-keeper description: Maintains Architectural Decision Records (ADRs) for this project. Creates, updates, lists, and supersedes ADRs in the /adr/ directory. user_invocable: true --- <scope> This skill manages the **Architectural Decision Record (ADR) process** for @zeix/cause-effect: - Create new ADRs from templates - Update existing ADRs (Proposed status only) - List all ADRs with status - Supersede ADRs with newer decisions - Maintain the ADR index **In scope:** All files in `/adr/` directory (at project root) **Out of scope:** REQUIREMENTS.md, ARCHITECTURE.md (use architect skill) **ADR directory:** This skill assumes ADRs are stored in `/adr/` at the project root. If your project uses a different location (e.g., `/docs/adr/`), the workflows will need to be adjusted accordingly. </scope> <essential_principles> **ADRs are immutable.** Once accepted, an ADR is never modified. Updates create new ADRs that supersede old ones. **Trace to requirements.** Every ADR must reference relevant sections from REQUIREMENTS.md (e.g., M1, S3, X1). **Sequential numbering.** ADRs use 4-digit sequential numbers (0001, 0002, ...). **Status is explicit.** Each ADR must have a clear status: Proposed, Accepted, Rejected, Superseded. **Concise over comprehensive.** Focus on the decision, context, and consequences. Avoid unnecessary detail. </essential_principles> <intake> What would you like to do with ADRs? 1. **Create** a new ADR 2. **Update** an existing ADR (only for Proposed status) 3. **List** all ADRs 4. **Supersede** an existing ADR 5. **Search** ADRs by keyword Wait for response before proceeding. </intake> <routing> | Response | Workflow | |---|---| | 1, "create", "new", "add" | workflows/create-adr.md | | 2, "update", "edit", "modify" | workflows/update-adr.md | | 3, "list", "show all", "index" | workflows/list-adr.md | | 4, "supersede", "replace", "deprecate" | workflows/supersede-adr.md | | 5, "search", "find", "grep" | workflows/list-adr.md (with filter) | **Intent-based routing:** - "I want to document a decision" → workflows/create-adr.md - "ADR 0005 needs a fix" → workflows/update-adr.md - "Show me all ADRs" → workflows/list-adr.md - "ADR 0002 is obsolete" → workflows/supersede-adr.md - "Find ADRs about reactivity" → workflows/list-adr.md </routing> <reference_index> All in `references/`: | File | Contents | |---|---| | adr-template.md | The template for new ADRs | | adr-index.md | Index of all ADRs with status | </reference_index> <workflows_index> All in `workflows/`: | Workflow | Purpose | |---|---| | create-adr.md | Create a new ADR from the template | | update-adr.md | Update a Proposed ADR (immutable after Accepted) | | list-adr.md | List all ADRs, optionally filtered by keyword | | supersede-adr.md | Create a new ADR that supersedes an existing one | </workflows_index>