Skip to content

feat(misc): Add GitHub star toast #409

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
Jul 29, 2025
Merged

feat(misc): Add GitHub star toast #409

merged 3 commits into from
Jul 29, 2025

Conversation

msukkari
Copy link
Contributor

@msukkari msukkari commented Jul 29, 2025

  • Popup a toast to star the github repo once the user has been on the page for over a minute. Timer starts only once the domain page is loaded
image

Summary by CodeRabbit

  • New Features

    • Introduced a toast notification encouraging users to star the Sourcebot GitHub repository, appearing after 60 seconds and dismissible.
    • The toast includes a direct link to the GitHub page and tracks user interaction for analytics.
  • Chores

    • Added new analytics events to monitor the display and interaction with the GitHub star toast notification.

@msukkari msukkari requested a review from brendan-kellam July 29, 2025 06:29
Copy link

coderabbitai bot commented Jul 29, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new React component, GitHubStarToast, was introduced to display a GitHub star prompt as a toast notification, with display logic managed via cookies. The component is now included in the domain layout. Additionally, two new event types related to the toast were added to the Posthog event map. The changelog was updated to document this new feature.

Changes

Cohort / File(s) Change Summary
GitHub Star Toast Component
packages/web/src/app/[domain]/components/githubStarToast.tsx
Added a client React component that shows a GitHub star prompt toast, manages display via cookies, and logs user interaction events.
Layout Integration
packages/web/src/app/[domain]/layout.tsx
Imported and rendered the GitHubStarToast component within the main layout's JSX structure.
Posthog Event Types
packages/web/src/lib/posthogEvents.ts
Added two new event types for tracking the display and click actions of the GitHub star toast.
Changelog Update
CHANGELOG.md
Added an unreleased entry documenting the addition of the GitHub star toast feature referencing PR #409.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHubStarToast
    participant Cookies
    participant Toast
    participant Posthog

    User->>GitHubStarToast: Page loads
    GitHubStarToast->>Cookies: Check 'github_popup_shown' and 'github_popup_start_time'
    alt Not shown and >60s elapsed
        GitHubStarToast->>Toast: Display GitHub star prompt
        Toast->>User: Show notification with action
        GitHubStarToast->>Posthog: Log wa_github_star_toast_displayed
        User->>Toast: Clicks GitHub star action
        Toast->>GitHub: Open repo in new tab
        Toast->>Posthog: Log wa_github_star_toast_clicked
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A toast pops up, a star to seek,
On GitHub’s page, go take a peek!
Cookies whisper, “Wait your turn,”
For sixty seconds, then you’ll learn—
A button bright, a bunny’s cheer,
“Star us, friend, and hop back here!”
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7737981 and ee0271d.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch msukkarieh/star

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • 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. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • 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.

This comment has been minimized.

@msukkari msukkari merged commit 45416a4 into main Jul 29, 2025
5 of 6 checks passed
@msukkari msukkari deleted the msukkarieh/star branch July 29, 2025 06:39
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