Skip to content

AGENTS.md

Latest commit

 

History

History
6 lines (6 loc) · 1.15 KB

AGENTS.md

File metadata and controls

6 lines (6 loc) · 1.15 KB
Raw
  • Use atomic commits with conventional commit messages
  • After making any fix, always run bun run clean && bun run setup && bun test to do a clean rebuild and confirm everything works from scratch before considering the fix complete. A fix is not verified until clean build + tests pass.
  • Every user-facing change (new features, API changes, new components, config changes) requires updating the relevant docs under docs/content/docs/.
  • Breaking changes require a migration guide in docs/content/docs/guides/migration.mdx.
  • ink-web bundles ink (a Node.js CLI framework) for the browser. Any new dependency that imports Node.js built-ins (fs, child_process, tty, net, etc.) will break the Next.js docs build unless packages/ink-web/scripts/fix-bundled-fs.ts is updated to stub the import. The script must handle all import forms: static (import X from), namespace (import * as X from), and dynamic (await import()).
  • To release a new version: bump version in packages/ink-web/package.json, run bun run build and bun test, commit as release: vX.Y.Z, then cd packages/ink-web && npm publish, then git tag vX.Y.Z && git push && git push --tags.