Conversation
Add a RubyGems version badge to the README and create ARCHITECTURE.md, a standalone guide that explains how the codebase works: the module prepend strategy, generated method lifecycle, cache adapter system, and a file map so developers can quickly find what they need. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation to make the gem easier to discover and easier to work on by linking to an internal architecture guide.
Changes:
- Added a RubyGems version badge to the README.
- Added
ARCHITECTURE.mddescribing Cacheable’s internal flow (prepend-based interceptor module, generated methods lifecycle, adapter resolution, memoization, and file map). - Linked the new architecture document from the README.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds gem version badge and a link to the new architecture guide. |
| ARCHITECTURE.md | New standalone internal architecture document and file map for quicker onboarding/navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
@rofreg appreciate your time and last one for a bit I swear 😅 |
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.
Add a RubyGems version badge to the README and create ARCHITECTURE.md, a standalone guide that explains how the codebase works: the module prepend strategy, generated method lifecycle, cache adapter system, and a file map so developers can quickly find what they need.