Skip to content

Commit da15ca1

Browse files
authored
docs: add AGENTS.md with CLAUDE.md symlink (#158)
This adds a minimal AGENTS.md as the canonical agent-context doc, with CLAUDE.md as a symlink to it so both the AGENTS.md and CLAUDE.md tool ecosystems resolve the same file. The content is deliberately minimal — a one-line overview plus verified development commands — since these files load into every agent context, so every line is a recurring token cost. Part of the marimo-team engineering-excellence initiative to give agents accurate, low-overhead repo context.
1 parent 1176517 commit da15ca1

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# codemirror-sql
2+
3+
CodeMirror 6 extension for SQL: real-time linting, gutter indicators, hover tooltips, and schema-aware autocomplete (DuckDB, BigQuery, Dremio dialects). Published to npm as `@marimo-team/codemirror-sql` and used by marimo's editor.
4+
5+
## Development
6+
7+
```bash
8+
pnpm install --ignore-scripts --frozen-lockfile # CI install
9+
pnpm test # vitest
10+
pnpm run test:browser # vitest browser tests (Playwright)
11+
pnpm run lint # oxlint --fix (autofix.ci runs this on PRs)
12+
pnpm exec oxlint # non-mutating lint CI enforces
13+
pnpm run typecheck # tsc --noEmit
14+
pnpm run demo # vite build of demo/
15+
```
16+
17+
- Browser tests need Playwright browsers installed first: `pnpm exec playwright install`.
18+
- Release: `pnpm run release` (pnpm version) bumps + tags; pushing a `v*` tag triggers release.yml, which publishes to npm via OIDC.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)