[CHA-2585] feat: add deprecation notice to README#203
Open
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
mogita
requested review from
JimmyPettersson85,
nijeesh-stream,
shaljam,
totalimmersion and
vishalnarkhede
as code owners
There was a problem hiding this comment.
Pull request overview
Adds an upfront maintenance-mode/deprecation notice to the project README to direct users toward the newer getstream-ruby SDK and provide a migration path.
Changes:
- Add a prominent notice recommending
getstream-rubyfor new projects. - Declare
stream-chat-rubyas maintenance mode while still supporting critical fixes. - Link to a migration guide with side-by-side examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| > | ||
| > **`stream-chat-ruby` is now in maintenance mode.** It will continue to receive critical fixes and requested features, so it is safe to keep using. However, we encourage existing users to migrate when convenient and strongly recommend that new projects start with `getstream-ruby`. | ||
| > | ||
| > Check out the [Migration Guide](https://github.com/GetStream/getstream-ruby/tree/master/docs/migration-from-stream-chat-ruby) for side-by-side examples covering common use cases. |
There was a problem hiding this comment.
The Migration Guide URL is pinned to the master branch of getstream-ruby. This is brittle (and may already be outdated if the upstream default branch is main), which would make the README link break. Consider updating to the upstream default branch name or using a permalink/tagged version for a stable link.
Suggested change
| > Check out the [Migration Guide](https://github.com/GetStream/getstream-ruby/tree/master/docs/migration-from-stream-chat-ruby) for side-by-side examples covering common use cases. | |
| > Check out the [Migration Guide](https://github.com/GetStream/getstream-ruby/tree/main/docs/migration-from-stream-chat-ruby) for side-by-side examples covering common use cases. |
totalimmersion
approved these changes
Mar 10, 2026
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.
Note
Low Risk
Documentation-only change that adds a maintenance-mode/deprecation notice and migration guidance; no code or runtime behavior is affected.
Overview
Updates
README.mdto clearly state thatstream-chat-rubyis in maintenance mode, recommendgetstream-rubyfor new projects, and link to a migration guide for existing users.Written by Cursor Bugbot for commit a6d252c. This will update automatically on new commits. Configure here.