Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a migration guide for updating between SDK versions #19

Open
adithyaakrishna opened this issue Oct 1, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@adithyaakrishna
Copy link
Contributor

As the Reclaim Protocol SDK evolves, a comprehensive migration guide would be invaluable for developers updating their implementations.

Tasks:

  1. Create a new markdown file named 'migration-guide.mdx'
  2. 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
  3. Add a section on best practices for keeping implementations up-to-date
  4. Include links to release notes for each version
  5. 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

@adithyaakrishna adithyaakrishna added documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest labels Oct 1, 2024
@adithyaakrishna adithyaakrishna added the good first issue Good for newcomers label Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant