Your PR Comment Should Include a Migration Guide

Flagging a breaking change is useful. Telling the developer exactly how to fix it is better. Delimit generates step-by-step migration guides and posts them directly on the PR.

What a migration guide looks like

# Migration Guide: Pet Store API (1.0.0 -> next)

This release contains 3 breaking change(s).
Follow the steps below to update your integration.

### Step 1: Endpoint Removed
DELETE /v1/pets/{id} was removed.
Action: Update clients to use the new endpoint or
        remove calls to this path.

### Step 2: Type Changed
/v1/pets id changed from string to integer.
Action: Update serialization/deserialization logic.
        Check type assertions, validators, and
        database column types.

### Step 3: Enum Value Removed
status: "pending" was removed from allowed values.
Action: Update clients to stop sending this value.
        Add handling for the new allowed values.

This appears as a collapsible section in the PR comment. Reviewers can expand it to see exactly what downstream consumers need to change.

7 output templates

Migration guides are one of 7 explain templates:

• pr_comment -- full PR comment with badges, tables, and migration steps
• migration -- standalone migration guide
• changelog -- version changelog entry
• developer -- technical deep-dive for engineers
• team_lead -- impact summary for managers
• product -- user-facing change summary
• slack -- concise notification for Slack/Teams

npx delimit-cli explain old.yaml new.yaml --template migration