From c6d57d5c23e6df2b98fc3688b53dd2fa0d02a05e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Maciejewski?= <1276139+pwlmaciejewski@users.noreply.github.com> Date: Sun, 8 Mar 2026 11:08:15 +0100 Subject: [PATCH] chore: add info about the decisions/ folder for the agents --- AGENTS.md | 7 +++++++ CLAUDE.md | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 2c515a3..3ca31e2 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -8,6 +8,7 @@ Single-package library (not a monorepo): - `src/` - Source code, one directory per effect type - `docs/` - VitePress documentation site +- `decisions/` - Architecture Decision Records (ADRs) - `dist/` - Build output (not committed) Each effect type follows the same layout: @@ -89,6 +90,12 @@ After a batch of code changes, verify that QA scripts pass (`lint`, `typecheck`, - Test behavior, not implementation. Prefer testing public API surfaces. - Algebraic law tests (functor, monad, applicative) use shared helpers from `src/testUtils/` +### Architecture Decisions + +- Architectural decisions are recorded as ADRs in `decisions/`, using the template in `decisions/adr-template.md`. +- Read existing ADRs before proposing changes that contradict them. +- When a decision is made that affects the project's architecture, create a new ADR. + ### Commits & PRs - Use conventional commits (e.g., `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`). diff --git a/CLAUDE.md b/CLAUDE.md index 2c515a3..3ca31e2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,6 +8,7 @@ Single-package library (not a monorepo): - `src/` - Source code, one directory per effect type - `docs/` - VitePress documentation site +- `decisions/` - Architecture Decision Records (ADRs) - `dist/` - Build output (not committed) Each effect type follows the same layout: @@ -89,6 +90,12 @@ After a batch of code changes, verify that QA scripts pass (`lint`, `typecheck`, - Test behavior, not implementation. Prefer testing public API surfaces. - Algebraic law tests (functor, monad, applicative) use shared helpers from `src/testUtils/` +### Architecture Decisions + +- Architectural decisions are recorded as ADRs in `decisions/`, using the template in `decisions/adr-template.md`. +- Read existing ADRs before proposing changes that contradict them. +- When a decision is made that affects the project's architecture, create a new ADR. + ### Commits & PRs - Use conventional commits (e.g., `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`).