diff options
| author | victor | 2026-10-24 15:57:01 +0200 |
|---|---|---|
| committer | victor | 2026-10-24 15:57:01 +0200 |
| commit | 4533910bce394e7a0ee6debfc05ca1221ee51899 (patch) | |
| tree | 73aaa5b2c7a48dbf226e6b81d499ba1a8ecc33a1 /AGENTS.md | |
| parent | Tilføj dansk (diff) | |
| download | 3D-Electrophysics-ny-start.tar.gz 3D-Electrophysics-ny-start.zip | |
Astra!ny-start
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..db45eee --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,53 @@ +# Project instructions + +## Purpose and scope + +Build an educational electrophysics application with interactive 3D graphics. +Treat `PLAN.md` as the source of truth for subject scope. A subject line +starting with `#` is excluded from implementation; the document's title and +introductory heading are not subjects. + +The only currently enabled subject is **Electric flux and charge**. Do not +implement other listed subjects unless the plan or the user enables them. +Use `docs/theory/` as subject references. Exercises and answers in `docs/` +provide context but do not expand the enabled scope. + +## Languages + +- The languages supported should be English and Danish + +## Repository and tooling + +- `src/`: application source, physics models, and 3D rendering. +- `tests/`: browser tests. +- `docs/`: educational references and exercises. +- `PLAN.md`: enabled and excluded subjects. +- The existing package manifest uses TypeScript, Vite, Three.js, and KaTeX, + with Vitest and Playwright for testing. +- `.nvmrc` specifies Node 22; `package.json` requires Node >=22.12.0. + +Available package scripts: + +| Command | Purpose | +| --- | --- | +| `npm run dev` | Start Vite on 127.0.0.1 | +| `npm run build` | Type-check and build for production | +| `npm run typecheck` | Run TypeScript checks | +| `npm test` | Run Vitest | +| `npm run test:e2e` | Run Playwright | +| `npm run preview` | Preview the production build | + +The manifest defines these commands, but source and configuration files may +still need to be created before they can run. Inspect the current working tree +and preserve existing user edits and deletions; do not restore deleted files +without a task requiring it. + +## Implementation guidance + +- Keep physics calculations separate from presentation and test meaningful + physical invariants, units, and limiting cases when implementing models. +- Keep explanations, equations, units, and visualizations consistent with the + educational references and state any simplifying assumptions. +- Provide accessible labels and keyboard-operable controls for interactions. +- Run checks appropriate to the changes. Report checks that could not run and + their actual blockers; do not claim unexecuted checks passed. |