workflow
API Contract Change Release Checklist
Check an API change for compatibility, rollout, observability, and rollback before it reaches existing clients.
Engineering guide
Practical review workflows for API changes, slow SQL, message queues, and legacy service refactors.
Review the backend change below as a production release owner. Return: (1) current and proposed contracts, (2) affected services, consumers, data, and queues, (3) compatibility, performance, security, and migration risks, (4) required tests, (5) observability signals, (6) rollout steps, and (7) an explicit rollback plan. Flag every assumption and identify the smallest safe release slice. Change context: [Paste the API change, schema change, SQL, queue behavior, deployment constraints, and traffic profile]
Document request and response shapes, database changes, queue messages, scheduled jobs, and downstream consumers. Record which fields are required, which defaults exist, and which clients can tolerate both old and new behavior.
Search source, gateways, event schemas, dashboards, jobs, exports, and runbooks. Include mobile clients and manually maintained integrations. For each dependency, record its expected version, owner, and observable failure mode.
Prefer additive changes, backward-compatible messages, feature flags, and staged traffic. Every migration should state which application versions can read and write each data shape during mixed-version deployment.
Add the new schema first, support both shapes, backfill in bounded batches, and compare old and new reads before switching traffic. Remove the old shape only after old code and consumers are gone in a later release.
Document ordering, retry limits, dead-letter behavior, and idempotency. Test duplicate delivery and poison messages, and ensure rollback cannot repeat completed business effects. Monitor oldest-message age as well as depth.
Choose error rate, p95 latency, queue lag, dead letters, reconciliation counts, and business completion rate. Assign a threshold, comparison window, and owner to each signal before deployment starts.
Start with an internal tenant, canary instance, region, or small traffic percentage. Compare it with a control and increase exposure only after the observation window passes without crossing guardrails.
Name the exact control, responsible person, data implications, and expected recovery time. Prepare a compatibility mode or forward fix for changes that cannot be reversed by deploying old code, and rehearse the procedure.
This guide turns production engineering practice into a repeatable decision process. Examples are checked for explicit inputs, observable outcomes, failure handling, and reversible actions. Validate the steps against your own traffic, data model, permissions, and recovery objectives.
Read our editorial and review standardsReusable resources
workflow
Check an API change for compatibility, rollout, observability, and rollback before it reaches existing clients.
prompt
Turn RabbitMQ queue growth into an evidence-based containment and retry plan without creating a retry storm.
workflow
Review an Oracle SQL statement with execution-plan evidence and produce a reversible optimization plan.
workflow
Design an agent MVP around a narrow human-reviewed outcome, not a vague autonomous promise.
prompt
Convert a Spring Boot exception sample into a precise investigation plan instead of a generic explanation.