Skip to content

docs: drop MIGRATE.md until the first release - #571

Merged
kixelated merged 2 commits into
mainfrom
drop-migrate
Nov 4, 2026
Merged

kixelated merged 2 commits into
mainfrom
drop-migrate

Conversation

@kixelated

Copy link
Copy Markdown
Collaborator

Problem

Nothing in rust2 is released yet, so ts/, ffi/ and uniffi/'s MIGRATE.md files guide no one, and every breaking PR pays to keep them current.

Approach

Delete the three files and the rule in AGENTS.md and CONTRIBUTING.md that asks for an entry. PRs still report their public API impact.

Impact

  • None on any package's API. Agents no longer add MIGRATE.md entries.

Alternatives

  • Keep the files and stop adding to them: they would rot.

Follow-ups

(written by Claude Opus 5.5)

🤖 Generated with Claude Code

kixelated and others added 2 commits November 3, 2026 22:14
Nothing is released yet, so there is no one to migrate.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
# Conflicts:
#	ts/MIGRATE.md
@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The contribution guidance no longer requires a migration entry for breaking public API changes. The ffi/MIGRATE.md, ts/MIGRATE.md, and uniffi/MIGRATE.md guides were deleted.

Merge Risk: Minimal · previous review b1583

This documentation-only change removes migration bookkeeping before the first release while retaining API impact reporting. No merge-blocking risk is identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly summarizes the main documentation change: removing MIGRATE.md files until the first release.
Description check Passed The description explains why the MIGRATE.md files and related contribution rules are being removed, and it matches the changeset.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Simplify code
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 12c08899-ab59-4945-8968-2dd9a93e14e5
Commits

Reviewing files that changed from the base of the PR and between dbbbe52 and b1583d2.

Files selected for processing: 5
  • AGENTS.md
  • CONTRIBUTING.md
  • ffi/MIGRATE.md
  • ts/MIGRATE.md
  • uniffi/MIGRATE.md
Files with no reviewable changes: 3
  • ts/MIGRATE.md
  • ffi/MIGRATE.md
  • uniffi/MIGRATE.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@kixelated
kixelated enabled auto-merge November 4, 2026 06:46
@kixelated
kixelated added this pull request to the merge queue Nov 4, 2026

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ No critical issues; one inaccurate line in the Follow-ups note, nothing in the diff.

Reviewed changes

  • AGENTS.md: drops the Public API rule requiring a breaking change to add an entry under ## Unreleased in the package's MIGRATE.md.
  • CONTRIBUTING.md: the Impact section no longer asks for a MIGRATE.md entry; it keeps "a bullet point for every public API change".
  • ffi/MIGRATE.md, ts/MIGRATE.md, uniffi/MIGRATE.md: deleted. 352 lines of migration notes for APIs that nothing released ships yet.

Verified against the tree: a case-insensitive grep finds no remaining MIGRATE.md references on the branch (the only "migrated" hit is unrelated prose in uniffi/bindgen-tests/README.md), and the same holds for main's three newer commits, so nothing goes stale on landing. The "nothing is released yet" premise checks out: no crate sets publish = true, the main packages (ts, ffi, go, uniffi) are all publish = false, and there is no npm package.json. No behavioral surface; docs and agent rules only.

The branch is three commits behind main; merging it in conflicts on ts/MIGRATE.md (main's #567 added an entry) and resolves by keeping the file deleted, as the body intends.

ℹ️ Follow-ups note cites PR states that don't match GitHub

The body says "Open PRs that add an entry (#555, #567, #569, #570)", but only #567 touches a MIGRATE.md and it is merged, not open; #555 and #570 touch no MIGRATE.md at all, and #569 has no files yet. The conflict to resolve is with main itself, via merged #567, when this branch merges it in, so anyone who checks the numbers will find the sentence wrong.

Technical details
# Follow-ups note cites PR states that don't match GitHub

## Affected sites
- PR #571 body, Follow-ups: "Open PRs that add an entry (#555, #567, #569, #570) resolve the conflict by keeping the file deleted; their agents have been told."

## Evidence
- #567 "feat(ts): keep a Cow<str>'s variant" is MERGED; its file list includes `ts/MIGRATE.md`, and its entry is on `main` (dbbbe527). The branch's deletion conflicts there, not in an open PR.
- #555 (OPEN, "bench(ts): measure a Vec wrapper...") and #570 (OPEN, "Every panic of a hooked program has its location") touch no `MIGRATE.md` in their current file lists.
- #569 (OPEN, "Placeholders written to a crate's own fmt::Write") has no files yet.

## Required outcome
- Restate the follow-up accurately: the conflict is with `main` via merged #567, and the open PRs' agents were told not to add entries; or drop the numbers if the coordination is the point.

## Suggested approach (optional)
- While editing the body, consider recording the title's promise (bring the guides back at the first release) as a quest, since follow-ups route there and nothing tracks it yet.

(Written by glm-5.3-flash)

Pullfrog  | Fix it ➔ | View workflow run | Using glm-5.3-flash | 𝕏

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ The new merge commit is clean; the Follow-ups wording from my earlier review is the only item still open.

Reviewed changes

  • Merge origin/main (ab5e8a6): brings in main through #567 and resolves the ts/MIGRATE.md conflict by keeping the file deleted, absorbing #567's Cow<str> entry into the deleted content. Exactly the resolution the body describes.

Re-verified after the merge: a case-insensitive grep over the branch still finds no MIGRATE.md references (the only "migrated" hit is unrelated prose in uniffi/bindgen-tests/README.md), and the branch is now up to date with main (dbbbe52), so nothing conflicts at landing.

The one outstanding item is unchanged: the body's "Open PRs that add an entry (#555, #567, #569, #570)" still reads as merged #567 plus three PRs whose current file lists touch no MIGRATE.md (details in my earlier review).

(Written by glm-5.3-flash)

Pullfrog  | Fix it ➔ | View workflow run | Using glm-5.3-flash | 𝕏

Merged via the queue into main with commit 25d1da1 Nov 4, 2026
4 checks passed
@kixelated
kixelated deleted the drop-migrate branch November 4, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant