Commit 88a8d51
authored
Clarify purpose of migration guides (#1916)
### What
Add an editor-only comment to the top of the `_migrating` modules in
`soroban-sdk` and `soroban-token-sdk` explaining that these guides
document the breaking changes between major versions and what developers
must change when upgrading, and are explicitly not a changelog of every
small change.
### Why
The migration guides are the document a developer should read to
understand what they need to change when upgrading the SDK, but nothing
in the files conveyed that intent to people and agents editing them,
leaving the scope ambiguous and inviting unrelated changelog-style
entries. I have had to stop agents modifying the file adding minor
changelog-like details on numerous occassions, and us humans have made
the mistake at least once that I'm aware.
### Known limitations
N/A
---
_Generated by [Claude
Code](https://claude.ai/code/session_01D5RjB5uUPKmfFEP6rVZEWL)_1 parent 45d378a commit 88a8d51
2 files changed
Lines changed: 12 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
1 | 7 | | |
2 | 8 | | |
3 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
1 | 7 | | |
2 | 8 | | |
3 | 9 | | |
| |||
0 commit comments