@teakit/money LLM Contract
@teakit/money is a TypeScript money-domain library being designed for precise amounts, currency-aware operations, explicit rounding, and safe serialization.
Generation Rules
- Target Node.js
>=22.2.0. - Use
/Users/billgo/.agents/skills/billgo-skills/SKILL.mdwhen available to select the workflow skill for non-trivial work. - Apply
code-guidelinesas the always-on behavioral layer for code and documentation changes. - Apply
teakitandtypescript-guidelineswhen changing this package's setup, source, tests, docs, or release flow. - Read
docs/proposals/v00-money.mdbefore proposing v1 API or behavior. - Keep generated examples aligned with real exports from
src/index.ts. - Update
README.md,skills/index.mdx, and this file when the public API changes. - Keep proposed APIs in proposals or specs until implementation exists.
- Document only real public APIs and supported workflows.
Current Public Surface
v1 Direction
- Model money as amount, currency, and scale rather than plain numbers.
- Prefer scaled integer representation and strict decimal-string parsing.
- Make rounding, allocation, and serialization choices explicit.
- Keep API examples small, deterministic, and TypeScript-first.
- Include agent-facing rules for common money mistakes once the APIs are implemented.
Project Workflow
- Read
AGENTS.mdbefore modifying the repository. - Read
docs/knowledge/index.mdanddocs/memory/index.mdwhen context is needed. - Use
skills/teakit-money/SKILL.mdfor repository-specific agent instructions. - Use
skills/teakit-money/references/main-concept.mdfor the current money concept boundary. - Use proposals for direction, specs for testable contracts, and implementation only after the behavior is clear.
- If API, behavior, commands, or agent-facing usage changes, update nearby tests and docs.