-
Notifications
You must be signed in to change notification settings - Fork 11
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfest
Description
As the Reclaim Protocol SDK evolves, a comprehensive migration guide would be invaluable for developers updating their implementations.
Tasks:
- Create a new markdown file named 'migration-guide.mdx'
- In this file, include:
- A table of contents listing all major versions
- For each version update (e.g., v1.x to v2.x), provide:
- A summary of major changes and new features
- A detailed list of breaking changes
- Step-by-step instructions for updating implementations
- Code snippets showing before and after examples for major changes
- A section on deprecated features and their planned removal dates
- Guidelines for testing after migration
- Troubleshooting tips for common issues encountered during migration
- Add a section on best practices for keeping implementations up-to-date
- Include links to release notes for each version
- Provide guidance on how to report issues or seek help during migration
This guide will help developers smoothly transition between different versions of the Reclaim Protocol SDK, ensuring they can take advantage of new features and improvements while minimizing disruption to their applications.
Contributors: Please note that by submitting a pull request, you are agreeing to accept and sign the Contributor License Agreement (CLA) found at https://github.com/reclaimprotocol/.github/blob/main/CLA.md
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfest