Change Guides
New route
Section titled “New route”- add the rule in a service;
- create or extend a controller;
- register it in the appropriate router;
- document method/path/auth/headers;
- test success, validation, errors, and access.
New migration
Section titled “New migration”Use the next number, version/name/up, and register it in the index without editing old migrations. Test an empty database and upgrade from the previous version.
New job
Section titled “New job”Define the handler, dedupe key, priority, concurrency/retry behavior, and observability. Test recovery and failure; expose an operation only when needed.
New reader format
Section titled “New reader format”Add the extension/capability, backend delivery, frontend engine, cover, progress, and cleanup. Test a real fixture, errors, touch, large files, and PWA behavior. Do not load an entire file without an explicit budget.
New storage provider (future)
Section titled “New storage provider (future)”There is no current interface. Such a change is architectural: preserve IDs, fingerprints, Range, retention, and transient failures; create an ADR before implementation.