Skip to content

[Phase 5] Migration Guide (Issue #47)#64

Merged
gmajor-encrypt merged 1 commit intomasterfrom
feature/migration-guide
Mar 30, 2026
Merged

[Phase 5] Migration Guide (Issue #47)#64
gmajor-encrypt merged 1 commit intomasterfrom
feature/migration-guide

Conversation

@gmajor-encrypt
Copy link
Copy Markdown
Owner

Summary

This PR adds a comprehensive migration guide for upgrading from php-scale-codec v1.x to v2.0.

Files Added

docs/MIGRATION.md

  • Overview of breaking changes
  • API changes with side-by-side code examples
  • Type system changes
  • Metadata interface changes
  • Step-by-step migration guide
  • Deprecated methods table
  • FAQ section

examples/05-migration-v1-to-v2.php

  • Side-by-side code comparisons (v1.x vs v2.0)
  • Setup, encoding, decoding examples
  • Compact, vector, option handling
  • Large integer handling
  • Error handling patterns
  • Compatibility wrapper example

CHANGELOG.md

  • Version history
  • Breaking changes summary
  • New features list
  • Fixed issues

Tasks from Issue #47

  • Analyze new vs old API differences
  • Write migration guide
  • Provide compatibility layer (wrapper example)
  • Migration example code
  • FAQ

Closes #47

- Add docs/MIGRATION.md - comprehensive migration guide
  - Breaking changes overview
  - API changes with side-by-side examples
  - Type system changes
  - Metadata changes
  - Step-by-step migration guide
  - FAQ section

- Add examples/05-migration-v1-to-v2.php
  - Side-by-side code comparisons
  - Compatibility wrapper example
  - Common migration patterns

- Add CHANGELOG.md
  - Version history
  - Breaking changes
  - New features

Closes #47
@gmajor-encrypt gmajor-encrypt merged commit 995ecdd into master Mar 30, 2026
1 check passed
@gmajor-encrypt gmajor-encrypt deleted the feature/migration-guide branch March 30, 2026 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Phase 5] Migration Guide

1 participant