Skip to content

Commit d5edcb3

Browse files
docs: add breaking changes guidance to CLAUDE.md (#1879)
1 parent 68cbabb commit d5edcb3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CLAUDE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,17 @@ This document contains critical information about working with this codebase. Fo
5151
- NEVER ever mention a `co-authored-by` or similar aspects. In particular, never
5252
mention the tool used to create the commit message or PR.
5353

54+
## Breaking Changes
55+
56+
When making breaking changes, document them in `docs/migration.md`. Include:
57+
58+
- What changed
59+
- Why it changed
60+
- How to migrate existing code
61+
62+
Search for related sections in the migration guide and group related changes together
63+
rather than adding new standalone sections.
64+
5465
## Python Tools
5566

5667
## Code Formatting

0 commit comments

Comments
 (0)