Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

docs: the repo is formatted now; drop the never-bulk-format rule from the guides

Carl-Gerhard Lindesvärd0a5371ce2f41
diff --git a/AGENTS.md b/AGENTS.md
index 660a8ead2..4c94fe449 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -85,7 +85,9 @@ a one-line fix does not need the full suite, a query or ingest change always doe
| Anything shared (`packages/shared`, `packages/db`, config, deps) | — | `bun run typecheck` and `bun run test` in full |
Always before you finish: `bun run typecheck`, and `npx ultracite fix <files you changed>`
-(never bare or on `.` — the repo is not bulk-formatted). Report what you ran and what you saw;
+(the repo is formatted and safe-fixed as of 2026-09-21, so a bare `bun run fix` is also
+fine; `bun run check` still reports a few hundred lint errors that need judgment, so only
+the files you touched have to come out clean). Report what you ran and what you saw;
a screenshot or a query result is evidence, "should work" is not.
Sending real events (`bun run send`, uses the seeded clients and `$API_URL`):
@@ -156,8 +158,9 @@ on the same data.
## Code style
-Formatting and linting is ultracite (Biome), **only on the files you changed**. Do not
-hand-format against it and do not disable rules to make a check pass.
+Formatting and linting is ultracite (Biome 2). Do not hand-format against it and do not
+disable rules to make a check pass. Generated and vendored files are excluded in
+`biome.json`; add to that list rather than reformatting build output.
- Constants over magic numbers: named, at the top of the file or in the module's
`<name>.constants.ts`.
diff --git a/packages/core/AGENTS.md b/packages/core/AGENTS.md
index 27cc6764d..01035bf7f 100644
--- a/packages/core/AGENTS.md
+++ b/packages/core/AGENTS.md
@@ -446,6 +446,6 @@ code. Never invent a cross-module abstraction to deduplicate two call sites.
**Always think hot path.** This is an ingestion platform: `/track`, the Kafka
consumer and the buffers get no per-request work that could have been per-boot.
-**Format with ultracite, only on the files you changed, named explicitly**
-(`npx ultracite fix <files...>`). Never bare and never on `.` — the repo has
-never been bulk-formatted.
+**Format with ultracite** (`npx ultracite fix <files...>`). The package is
+formatted and safe-fixed as of 2026-09-21; a bare run only touches what
+drifted, so it is fine, but the files you changed must come out clean.