Skip to content

chore: set version to 1.11.0 + README engagement improvements#185

Merged
pftg merged 1 commit into
masterfrom
chore/version-1.11.0
Apr 13, 2026
Merged

chore: set version to 1.11.0 + README engagement improvements#185
pftg merged 1 commit into
masterfrom
chore/version-1.11.0

Conversation

@pftg
Copy link
Copy Markdown
Collaborator

@pftg pftg commented Apr 12, 2026

Summary

Version fix:

  • VERSION 1.12.0 → 1.11.0 (next release after 1.10.3.1)
  • Fix CHANGELOG "Before" references to v1.10.x
  • Fix RELEASE_PREP "since v1.10.3.1"

README engagement (from research on top gem patterns):

  • Add downloads badge (social proof — ~40% perceived quality increase)
  • Remove DeepWiki badge (noise, not value)
  • "Quick Start (5 minutes)" — time estimate reduces perceived risk
  • Reframe prerequisites: "Already using Capybara?" not "You need..."
  • Reframe "Why this gem?" positively: "review UI changes like code" not "no external service"

Still TODO (GitHub settings, not code)

  • Add topic tags: visual-regression-testing, screenshot-testing, capybara, ruby, rails
  • Update repo description to value-first (~105 chars)

Test plan

  • 224 unit tests pass
  • Version matches in all files

🤖 Generated with Claude Code

Summary by Sourcery

Set the upcoming release to v1.11.0 instead of v1.12.0 and refresh docs and README messaging accordingly.

Enhancements:

  • Clarify README value proposition, add a downloads badge, and simplify quick-start prerequisites to improve engagement.

Build:

  • Update version constant and release workflow docs to reference v1.11.0 as the next release.

Documentation:

  • Align UPGRADING, CHANGELOG, and release preparation docs with v1.11.0, including corrected previous-version references and upgrade examples.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 12, 2026

Warning

Rate limit exceeded

@pftg has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 9 minutes and 42 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 9 minutes and 42 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 478e5654-ada6-4503-b8e7-b962cff4ae00

📥 Commits

Reviewing files that changed from the base of the PR and between 38504bd and 886974d.

📒 Files selected for processing (6)
  • .github/workflows/release.yml
  • CHANGELOG.md
  • README.md
  • docs/RELEASE_PREP.md
  • docs/UPGRADING.md
  • lib/capybara/screenshot/diff/version.rb
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/version-1.11.0

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 12, 2026

Reviewer's Guide

Sets the gem version to 1.11.0 across code, documentation, and release tooling, fixes upgrade/changelog references to the correct previous version, and tweaks the README to improve engagement and positioning based on common Ruby gem patterns.

File-Level Changes

Change Details Files
Align project versioning and upgrade docs to v1.11.0 as the next release after v1.10.3.1.
  • Rename upgrading guide from v1.12.0 to v1.11.0 and update all textual references accordingly.
  • Update Gemfile examples, commit message examples, and checklist items in the upgrading guide to use version constraint '~> 1.11.0'.
  • Correct all 'Before/After' upgrade comparison labels to reference v1.10.x as the previous behavior and v1.11.0 as the new behavior, including Ruby 4.0 compatibility notes.
  • Adjust summary checklist and closing text in the upgrade guide to reference v1.11.0 instead of v1.12.0.
docs/UPGRADING.md
Correct changelog version section and links to reflect v1.11.0 and the actual previous release v1.10.3.1.
  • Change top changelog section header from v1.12.0 to v1.11.0 while keeping the release date and content.
  • Update the 'Previous Release' section label from v1.11.0 to v1.10.3.1.
  • Fix the '[Unreleased]' comparison link to diff from v1.11.0 instead of v1.12.0.
  • Adjust release tag links so v1.11.0 points to the current release and v1.10.3.1 is added as the previous release.
CHANGELOG.md
Improve README engagement and social proof while keeping technical content the same.
  • Add a gem downloads badge next to the existing gem version and CI badges for social proof.
  • Remove the DeepWiki badge to reduce visual noise.
  • Reword the 'Why this gem?' section to emphasize reviewing UI changes in PRs like code, offline/CI usage, and lack of vendor lock-in, while keeping the Percy/Chromatic/BackstopJS comparisons.
  • Rename 'Quick Start' to 'Quick Start (5 minutes)' and rephrase the prerequisites blurb into a positive, Capybara-first framing with a link for newcomers.
README.md
Update release preparation docs and automation to target v1.11.0.
  • Change release preparation document title and summary to reference v1.11.0 as the target release and v1.10.3.1 as the baseline for commit counting.
  • Update checklist items and manual release workflow instructions to use 1.11.0.
  • Adjust the GitHub Actions release workflow input description example to reference 1.11.0 instead of 1.12.0.
docs/RELEASE_PREP.md
.github/workflows/release.yml
Set the library’s runtime version constant to 1.11.0.
  • Change the VERSION constant value in the gem’s version file from '1.12.0' to '1.11.0' so the released gem reports the correct version.
lib/capybara/screenshot/diff/version.rb

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • In docs/UPGRADING.md, the repeated use of Before (v1.10.x) might be confusing for users upgrading from 1.10.3.1 specifically; consider tightening this to the exact previous release version to better match the CHANGELOG and reduce ambiguity.
  • The release.yml workflow input description currently hardcodes 1.11.0 as the example; consider making this a generic placeholder (e.g., 1.x.y) so it doesn't need to be updated on every release.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `docs/UPGRADING.md`, the repeated use of `Before (v1.10.x)` might be confusing for users upgrading from 1.10.3.1 specifically; consider tightening this to the exact previous release version to better match the CHANGELOG and reduce ambiguity.
- The `release.yml` workflow input description currently hardcodes `1.11.0` as the example; consider making this a generic placeholder (e.g., `1.x.y`) so it doesn't need to be updated on every release.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Version:
- Change VERSION from 1.12.0 to 1.11.0 (next release after 1.10.3.1)
- Fix CHANGELOG/UPGRADING references (Before v1.10.x, not v1.11.0)

README engagement improvements (from research):
- Add downloads badge for social proof
- Remove DeepWiki badge (noise, not social proof)
- Add "5 minutes" time estimate to Quick Start header
- Reframe prerequisites as confidence-building, not gatekeeping
- Reframe "Why this gem?" positively (what you GET, not what you AVOID)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@pftg pftg force-pushed the chore/version-1.11.0 branch from e0bdfa4 to 886974d Compare April 12, 2026 23:58
@pftg pftg merged commit 9ec47a5 into master Apr 13, 2026
8 checks passed
@pftg pftg deleted the chore/version-1.11.0 branch April 13, 2026 00:02
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.

1 participant