sscoble/pi-mono
1
0
Fork 0
mirror of https://github.com/badlogic/pi-mono.git synced 2026-11-05 23:37:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: simplify backward compatibility rule

Browse source
This commit is contained in:
Petr Houška 2026-11-02 19:36:17 +01:00
parent f56bbd27fe
commit 9f2a5ef19d
1 changed files with 1 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

5
AGENTS.md
View file

@ -23,10 +23,7 @@
- Never remove or downgrade code to fix type errors from outdated deps; upgrade the dep instead.
- Use only erasable TypeScript syntax (Node strip-only mode) in code checked by the root config (`packages/*/src`, `packages/*/test`, `packages/coding-agent/examples`): no parameter properties, `enum`, `namespace`/`module`, `import =`, `export =`, or other constructs needing JS emit. Use explicit fields with constructor assignments.
- Always ask before removing functionality or code that appears intentional.
- Preserve backward compatibility of public APIs, exports, types, CLI flags, settings, and file formats in minor and patch releases. Breaking changes ship only in major releases.
- Instead of removing or changing something, keep the old form working (deprecated alias, re-export, shim, fallback) next to the new one.
- Mark every such compatibility shim with a `// remove-in-next-major: <what to remove and why>` comment so it can be found (`rg remove-in-next-major`) and deleted in the next major release. Exported symbols additionally get a `/** @deprecated Use <replacement>. */` JSDoc so users see the deprecation in their editor.
- If a change cannot be made backward compatible, stop and ask the user before making it.
- Never break public APIs outside a major release. Keep the old form working next to the new one and mark it `// remove-in-next-major: <what and why>`. If that is not possible, ask first.
- Never hardcode key checks (e.g. `matchesKey(keyData, "ctrl+x")`). Add defaults to `DEFAULT_EDITOR_KEYBINDINGS` or `DEFAULT_APP_KEYBINDINGS` so they stay configurable.
- Never modify `packages/ai/src/models.generated.ts` directly; update the catalog definitions in `packages/ai/catalog/` instead (see its README), then regenerate. Including the resulting `models.generated.ts` diff is always OK, even if regeneration includes unrelated upstream model metadata changes. The generated model data in `packages/ai/src/providers/data/` is gitignored: never stage it, and don't look for it in git history.