Skip to content

docs: say what the repo owns and what it leaves to others #423

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
GraemeF merged 1 commit into from
Oct 3, 2026
Merged

docs: say what the repo owns and what it leaves to others #423

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
22 changes: 22 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
## What eventsourcing owns

eventsourcing is a set of event sourcing libraries for TypeScript, built on Effect and published to npm as the `@codeforbreakfast/eventsourcing-*` packages. An agent here decides and changes:

- the event store interface and its in-memory, filesystem and PostgreSQL implementations
- the write side and read side: aggregates, commands and projections
- the protocol, the transport contracts and their in-memory and WebSocket implementations, and the server that puts them together
- the testing contracts that any store or transport implementation can run against itself
- `bun-test-effect` and `eslint-effect`, the Effect testing and lint helpers published from this repo
- the todo-app example and the docs under `docs/`
- versioning, changesets and releases of every package above

## What it does not own

- **Effect itself** belongs to the upstream Effect project. An agent here adapts to Effect's API and reports bugs upstream, and does not patch or fork it.
- **Bun, Turbo, PostgreSQL and the other tools** belong to their upstream projects.
- **An application built on these libraries** belongs to whoever builds it. That covers its domain events, aggregates, projections and read models.
- **A deployment** belongs to whoever runs it. That covers the PostgreSQL database, its migrations as applied, the hosting, the credentials, and how a WebSocket server is exposed to a network.
- **The events in a user's store** belong to that user. An agent here never needs real event data, and invents any example it uses.

An agent may decline an ask that falls outside this remit, and should say which owner above the ask belongs to.

# 🚨 CRITICAL GIT WORKTREE WORKFLOW - DO THIS FIRST! 🚨

**BEFORE ANY CODE CHANGES - USE WORKTREES:**
Expand Down
Loading