You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`packages/integrations` — external APIs and transport adapters
66
+
-`docs/` — architecture, workflows, and decision records
67
+
68
+
Navigation hints:
69
+
70
+
- Start in `packages/core` for business logic questions
71
+
- Start in `apps/web` for request/route entrypoints
72
+
- Start in `packages/db` for data access or persistence issues
73
+
- Start in `packages/integrations` for external API behavior
74
+
- Check `docs/architecture.md` for system-level flows
2
75
3
76
## Mission
4
77
5
78
Build Atlas as a production-quality, Telegram-first planning assistant. The codebase should stay understandable to a new contributor and safe for repeated agent-driven edits.
6
79
7
-
## Architecture rules
80
+
## Architecture Rules
8
81
9
82
-`apps/web` owns delivery surfaces only: API routes, cron entrypoints, and internal admin pages.
10
83
- Business logic belongs in `packages/*`, not in route handlers or page components.
@@ -13,37 +86,54 @@ Build Atlas as a production-quality, Telegram-first planning assistant. The code
13
86
-`packages/db` implements persistence and repositories; do not spread SQL or ORM calls throughout the app.
14
87
-`packages/integrations` owns external API clients and transport adapters, not product logic.
15
88
16
-
## Anti-slop guardrails
89
+
## Anti-Slop Guardrails
17
90
18
91
- Prefer extending an existing module before creating a new abstraction.
19
92
- Do not add a dependency without a short reason in the change summary.
20
93
- No catch-all `utils` files unless the helpers are truly cross-cutting and cohesive.
21
94
- Keep files focused. If a file starts spanning multiple responsibilities, split by behavior.
22
95
- Keep comments rare and purposeful. Explain why, not what.
23
96
24
-
## Testing rules
97
+
## Testing Rules
25
98
26
99
- Every core business rule or planning/scheduling heuristic should have a unit test.
27
100
- Every webhook, reminder, or replanning bug fix requires an integration test.
28
101
- Structured OpenAI outputs must be validated at the boundary and covered by contract tests.
29
102
30
-
## Documentation rules
103
+
## Documentation Rules
31
104
32
105
- Update `README.md` when setup or core commands change.
33
106
- Update `docs/architecture.md` when dependency direction or major flow changes.
34
107
- When touching schemas, migrations, persisted records, ingestion record creation, or core data types, verify the change matches `docs/architecture/data-model-boundaries.md` and update that doc if the ownership model changes.
35
108
- Add an ADR in `docs/decisions/` for meaningful infrastructure or architecture decisions.
36
109
- Update `docs/current-work.md` when the active implementation focus changes.
37
110
38
-
## Git workflow rules
111
+
### Git Workflow Rules
112
+
113
+
- Every workflow — no exceptions — must use a git worktree and a dedicated branch.
0 commit comments