Skip to content

Add Sponsor button to README #796

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

Merged
merged 3 commits into from
Aug 22, 2025
Merged

Add Sponsor button to README #796

merged 3 commits into from
Aug 22, 2025

Conversation

szepeviktor
Copy link
Contributor

@szepeviktor szepeviktor commented Aug 21, 2025

Copy link
Contributor

coderabbitai bot commented Aug 21, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Added a “Support my work” sponsorship section to README.md with a CTA, sponsor button image/link, and the sentence “They already do.” Placed after the intro about AI tools. No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Docs: README
README.md
Inserted sponsorship section with CTA, button image/link, and supporting text; positioned after introductory description. No other content modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • yamadashy
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@szepeviktor szepeviktor marked this pull request as ready for review August 21, 2025 15:49
@Copilot Copilot AI review requested due to automatic review settings August 21, 2025 15:49
@szepeviktor szepeviktor requested a review from yamadashy as a code owner August 21, 2025 15:49
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a new sponsorship section to the README file, encouraging users to support the project maintainer through GitHub Sponsors.

  • Adds a "Support my work" section with a sponsor button
  • Includes explanatory text encouraging sponsorship
  • Places the new section before the existing sponsors image

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
README.md (3)

56-56: Make the image alt text more descriptive for accessibility.

Screen readers will announce just “Sponsor.” Prefer action + target (who/what).

-[![Sponsor](.github/assets/github-like-sponsor-button.svg)](https://github.com/sponsors/yamadashy)
+[![Sponsor yamadashy on GitHub](.github/assets/github-like-sponsor-button.svg)](https://github.com/sponsors/yamadashy)

54-58: Align tone with the rest of the README (“we/us” voice) and clarify “They already do.”

Most of the README uses a collective voice. Also, “They already do.” reads a bit ambiguous out of context.

-Please consider sponsoring me.
+Please consider sponsoring Repomix or its maintainer.
@@
-They already do.
+Current sponsors:

56-56: Sponsor button asset verified; optional improvement for npm rendering

  • The file .github/assets/github-like-sponsor-button.svg exists and is tracked in Git (confirmed by git ls-files and fd)
  • README.md line 56 currently uses a relative path:
    [![Sponsor](.github/assets/github-like-sponsor-button.svg)](https://github.com/sponsors/yamadashy)
  • Note: npmjs.com and some mirrors don’t serve relative README assets from the repo, so the image may break outside GitHub

Optional refactor: switch to an absolute raw URL for universal compatibility:

-[![Sponsor yamadashy on GitHub](.github/assets/github-like-sponsor-button.svg)](https://github.com/sponsors/yamadashy)
+[![Sponsor yamadashy on GitHub](https://raw.githubusercontent.com/yamadashy/repomix/main/.github/assets/github-like-sponsor-button.svg)](https://github.com/sponsors/yamadashy)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a691315 and c0e3526.

⛔ Files ignored due to path filters (1)
  • .github/assets/github-like-sponsor-button.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

52-59: Straightforward sponsor CTA — looks good where it is.

The new section is concise, on-brand, and placed in a high-visibility spot between the intro and awards. No functional risk to the repo tooling.

Removed redundant heading and text for cleaner sponsor section layout.
@yamadashy
Copy link
Owner

@szepeviktor
Thank you so much for the PR!

I've made a small adjustment to simplify the content a bit, but I'll merge it as is!

Really appreciate your contribution! 🙏

@yamadashy yamadashy merged commit 818949c into yamadashy:main Aug 22, 2025
1 check was pending
@szepeviktor szepeviktor deleted the patch-1 branch August 22, 2025 06:24
@szepeviktor
Copy link
Contributor Author

Here is a button for you. You may press it.

Sponsor

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