Repository navigation
docs: propose serialization compatibility policy - #355
Open
andystaples wants to merge 2 commits into
Open
andystaples wants to merge 2 commits into
andystaples wants to merge 2 commits into
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
JsonDataConverterbehavior, replay risks, and application-defined hooks and custom converters.Related to #354, #346, and #310.