Skip to content

docs: propose serialization compatibility policy - #355

Open
andystaples wants to merge 2 commits into
microsoft:mainfrom
andystaples:andystaples-serialization-policy
Open

andystaples wants to merge 2 commits into
microsoft:mainfrom
andystaples:andystaples-serialization-policy

Conversation

@andystaples

Copy link
Copy Markdown
Contributor

Summary

  • Propose deferring new default-serializer types and unsupported cases to a breaking major release, with exceptions for security fixes and repairs to already-supported behavior.
  • Document current JsonDataConverter behavior, replay risks, and application-defined hooks and custom converters.
  • Add contributor and pull-request guidance for assessing serialization compatibility.

Related to #354, #346, and #310.

andystaples and others added 2 commits November 11, 2026 11:07
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@andystaples
andystaples marked this pull request as ready for review November 11, 2026 18:44
Copilot AI balanced review requested due to automatic review settings November 11, 2026 18:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain for this documentation-only update to serialization compatibility and replay-safety guidance.

No open issues 🎉

What changed in this PR

This documentation-only PR proposes a serialization compatibility policy for the Durable Task SDK and its providers, emphasizing replay safety between major releases. It also documents current converter behavior without changing runtime functionality.

Changes:

  • Proposes deferring new default-serializer support to major releases, with exceptions for security fixes and repairs to documented behavior.
  • Documents reconstruction support, replay risks, and application-defined hooks and converters.
  • Adds contributor guidance and a pull-request checklist for serialization compatibility.
File Description
README.md Links to the serialization and replay guide.
docs/​supported-patterns.md Clarifies custom-object serialization and reconstruction guidance.
docs/​serialization.md Documents the proposed policy, current support, and customization options.
CONTRIBUTING.md Adds compatibility assessment and replay-mitigation requirements.
CHANGELOG.md Links the existing replay warning to the new guide.
.github/​PULL_REQUEST_TEMPLATE.md Adds a serialization compatibility checklist item.
.github/​copilot-instructions.md Adds serialization compatibility review guidance.

Review effort: Balanced

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.

2 participants