Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
md 44 lines 1.12 KB
Rendered Raw
1 # Decision Records
2
3 ## Location
4
5 Use `docs/decisions/` for docs decisions and long-running docs plans. Read `docs/decisions/README.md` before adding or editing records.
6
7 ## Style
8
9 - State the decision first.
10 - Include problem context, architecture, operational rules, and follow-up steps.
11 - Prefer durable product/docs constraints over chat transcripts or implementation diary entries.
12 - Keep file names lowercase and descriptive.
13 - Add every new decision record to `docs/decisions/README.md`.
14
15 ## Template
16
17 ```markdown
18 # Decision Title
19
20 ## Decision
21
22 State the accepted direction in one or two paragraphs.
23
24 ## Context
25
26 Describe the problem, constraints, and alternatives that matter.
27
28 ## Consequences
29
30 List operational rules, tradeoffs, and follow-up work.
31
32 ## Verification
33
34 Name commands, generated artifacts, or review checks that prove future changes still honor the decision.
35 ```
36
37 ## Updating Existing Decisions
38
39 When a docs change alters an existing decision:
40
41 1. Read the current record.
42 2. Patch the decision or add a dated note.
43 3. Update `docs/decisions/README.md`.
44 4. Verify links with `bun run lint:links` when content links changed.