Modernize README to follow Ruby open source best practices #77
Conversation
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
cardmagic
force-pushed
the
docs/modernize-readme
branch
from
139a213 to
d7fe2ab
Compare
- Add badges for gem version, CI status, and license - Add table of contents for easier navigation - Add Ruby compatibility matrix (3.1-3.4) - Improve installation with Bundler instructions - Use collapsible sections for GSL install and benchmarks - Add syntax highlighting to all code blocks - Add Development section with setup and test instructions - Add Contributing guidelines - Improve examples (spam filter, persistence, LSI search) - Reorganize structure with Quick Start sections Closes #76
cardmagic
force-pushed
the
docs/modernize-readme
branch
from
d7fe2ab to
3a2694d
Compare
There was a problem hiding this comment.
Pull request overview
This PR modernizes the README.md to follow current Ruby open source best practices by adding professional formatting, badges, better navigation, and comprehensive documentation sections.
Key Changes:
- Added gem version, CI status, and license badges at the top
- Restructured content with table of contents and collapsible sections for optional content
- Enhanced code examples with proper syntax highlighting and more realistic use cases
- Added development setup and contributing guidelines
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Complete overhaul with badges, structured sections, improved examples, syntax highlighting, and development/contributing guidelines |
| .github/workflows/ruby.yml | Added Ruby 4.0 to CI test matrix to match README compatibility table |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| </details> | ||
|
|
||
| <details> | ||
| <summary><strong>Ruby 2 and earlier</strong></summary> |
There was a problem hiding this comment.
The heading 'Ruby 2 and earlier' is inconsistent with the previous section 'Ruby 3+'. This should be 'Ruby 2.x and earlier' for clarity, or 'Ruby 3.3 and earlier' to match the original text if this section applies to Ruby 3.3 and below.
Suggested change
| <summary><strong>Ruby 2 and earlier</strong></summary> | |
| <summary><strong>Ruby 2.x and earlier</strong></summary> |
cardmagic
force-pushed
the
docs/modernize-readme
branch
from
78c6a02 to
fedc833
Compare
cardmagic
force-pushed
the
docs/modernize-readme
branch
from
87ac518 to
8119d67
Compare
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.
Summary
Modernizes README.md to follow current best practices for open source Ruby libraries.
Changes
<details>sections for GSL install and benchmarksBefore/After
Before: Basic markdown without badges, mixed formatting, no development instructions
After: Professional README with badges, clear structure, collapsible sections, proper syntax highlighting
Closes #76