Skip to content

Commit 87abeb9

Browse files
committed
docs: add migration guide policy to DESIGN_PRINCIPLES.md
Migration guides (e.g., docs/migration/v3-migration-prompt.md) serve as meta-prompts for AI coding agents, not step-by-step user instructions. The agent reads the guide, compares it against the user's codebase, and builds a project-specific migration plan. Add the migration guide section after ADR, covering: - Purpose and intended consumer (AI agents) - File placement convention (docs/migration/) - Rule to include a link in BREAKING CHANGE: commit footer so release-please surfaces it in GitHub Release notes
1 parent a463b5c commit 87abeb9

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

.serverless-full-stack-webapp-starter-kit/design/DESIGN_PRINCIPLES.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,19 @@ The litmus test for any PR: "After this merges, will a developer who copies the
5151
### Architecture Decision Records (ADR)
5252

5353
ADRs are not used yet. Introduce `design/adr/` when a major technology decision is made (e.g., ORM migration, database engine change) that requires recording the context, alternatives considered, and rationale.
54+
55+
### Migration guides
56+
57+
When a breaking change is introduced, write a migration guide alongside the ADR. Place it in `docs/migration/` (e.g., `docs/migration/v3-migration-prompt.md`).
58+
59+
A migration guide is not a complete step-by-step procedure for users. It is an input for an AI coding agent — a meta-prompt that the agent reads, compares against the user's codebase, and uses to build a project-specific migration plan. Write it with that consumer in mind: describe what changed, why, and what patterns in user code are affected, rather than prescribing exact commands.
60+
61+
To surface the guide in release notes, include a link in the `BREAKING CHANGE:` commit footer:
62+
63+
```
64+
feat!: replace ORM from Prisma to Drizzle
65+
66+
BREAKING CHANGE: ORM has been replaced. See [migration guide](docs/migration/v3-migration-prompt.md) for details.
67+
```
68+
69+
release-please will carry this into the Breaking Changes section of the GitHub Release.

0 commit comments

Comments
 (0)