Skip to content

chore: add info about the decisions/ folder for the agents #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pwlmc merged 1 commit into from
Mar 8, 2026
Merged

chore: add info about the decisions/ folder for the agents #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:`).
Expand Down
7 changes: 7 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:`).
Expand Down