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

[SDK-4379] Readme / migration guide tweaks #661

Merged
merged 8 commits into from
Jul 7, 2023

Conversation

stevehobbsdev
Copy link
Contributor

Changes

This PR includes changes to the readme, examples and migration guide for the upcoming beta:

  • BREAKING_CHANGES.md renamed to MIGRATION_GUIDE.md
  • Migration guide reformatted for readability
  • Tweaks in the readme file to account for upcoming breaking changes

Testing

Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

  • This change adds unit test coverage
  • This change has been tested on the latest version of the platform/language or why not

Checklist

@stevehobbsdev stevehobbsdev marked this pull request as ready for review June 30, 2023 10:01
@stevehobbsdev stevehobbsdev requested a review from a team as a code owner June 30, 2023 10:01
MIGRATION_GUIDE.md Show resolved Hide resolved
MIGRATION_GUIDE.md Outdated Show resolved Hide resolved
MIGRATION_GUIDE.md Outdated Show resolved Hide resolved
MIGRATION_GUIDE.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@poovamraj poovamraj merged commit 45a02ce into vnext Jul 7, 2023
1 check passed
@poovamraj poovamraj deleted the sdk-4379/breaking-changes branch July 7, 2023 09:20
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