-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtech-spec.md.example
More file actions
76 lines (56 loc) · 1.88 KB
/
Copy pathtech-spec.md.example
File metadata and controls
76 lines (56 loc) · 1.88 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
# tech-spec.md Customization Guide
This file is a template for local project technical notes.
Use it only for concrete technical stack details and technical constraints that agents must follow while working in the repository.
## Technology stack
- language:
- runtime:
- framework:
- package manager:
- database:
- test framework:
- build tool:
- deployment target:
## Required commands
List commands agents should use:
- install:
- format:
- lint:
- typecheck:
- test:
- build:
- codegen:
- migration check:
## Forbidden or unsafe commands
List commands agents must not run, or may run only with explicit approval:
- command:
- reason:
- safer alternative:
## Technical notes
Document concrete project-specific technical constraints:
- generated files:
- migration rules:
- runtime compatibility:
- API compatibility:
- platform-specific notes:
- local service requirements:
- known command caveats:
## Architecture source of truth
If you are using the AI coding architecture methodology, link the four core architecture files here:
- AI coding architecture: ./tech-spec/ai-coding-architecture.md
- Contract/state matrix: ./tech-spec/contract-state-matrix.md
- Hard parts register: ./tech-spec/hard-parts-register.md
- Task acceptance matrix: ./tech-spec/task-acceptance-matrix.md
## ProofLoop projection rules
- Propose may project these docs into OpenSpec artifacts.
- Propose must not weaken acceptance criteria.
- Executor must use tasks and evidence requirements derived from OpenSpec artifacts.
- Any architecture drift must update the relevant source document through Brain-authorized General edit.
## Do not put here
- ProofLoop route definitions.
- Agent role behavior.
- Dispatch packet fields.
- Product roadmap.
- PRD content.
- Broad architecture essays.
- Data-flow documentation unless it directly affects commands or technical constraints.
- Task plans or implementation checklists.