Skip to content

added tooltip bubble for project name #175

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

vedansh-5
Copy link
Contributor

@vedansh-5 vedansh-5 commented Jul 3, 2025

πŸ“Œ Fixes

Fixes #154


πŸ“ Summary of Changes

  • Short description of what was changed
  • Include links to related issues/discussions if any

πŸ“Έ Screenshots / Demo (if UI-related)

image
image

βœ… Checklist

  • I’ve tested my changes locally
  • I’ve added tests (if applicable)
  • I’ve updated documentation (if applicable)
  • My code follows the project’s code style guidelines

πŸ‘€ Reviewer Notes

Add any special notes for the reviewer here

Summary by Sourcery

Enhancements:

  • Add tooltip bubble clarifying the project name usage in the email subject line.

Copy link
Contributor

sourcery-ai bot commented Jul 3, 2025

Reviewer's Guide

Inserted an inline tooltip bubble next to the β€œYour Project Name” header by wrapping a question-mark icon and explanatory text in a tooltip container.

File-Level Changes

Change Details Files
Add tooltip bubble for project name label
  • Insert span.tooltip-container wrapping the icon and bubble
  • Add element with question-icon class
  • Embed span.tooltip-bubble containing explanatory text
src/popup.html

Assessment against linked issues

Issue Objective Addressed Explanation
#154 When a project name is provided, the report should only include activity related to that project. ❌ The PR only adds a tooltip to the project name input field, it does not address the underlying issue of the report including all activity regardless of the project name provided.
#154 When no project name is provided, the report should include all activity in the organization. ❌ The PR does not modify the report generation logic, so it doesn't affect this behavior.
#154 Fix the bug where the report is generated for all activity in the organization, even when a project name is provided. ❌ The PR only adds a tooltip. It does not fix the bug.

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

@vedansh-5 vedansh-5 self-assigned this Jul 3, 2025
@vedansh-5 vedansh-5 requested a review from hpdang July 3, 2025 18:30
Copy link
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 @vedansh-5 - I've reviewed your changes - here's some feedback:

  • Consider extracting the tooltip markup into a reusable component or template so you can easily apply it to other fields without duplicating HTML.
  • Enhance accessibility by adding ARIA attributes (e.g., role="tooltip" and aria-describedby) and keyboard support for the tooltip bubble.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider extracting the tooltip markup into a reusable component or template so you can easily apply it to other fields without duplicating HTML.
- Enhance accessibility by adding ARIA attributes (e.g., role="tooltip" and aria-describedby) and keyboard support for the tooltip bubble.

## Individual Comments

### Comment 1
<location> `src/popup.html` </location>
<code_context>
+					<h4>Your Project Name<span class="tooltip-container ml-2">
</code_context>

<issue_to_address>
Consider improving tooltip accessibility for screen readers.

Use ARIA attributes like aria-label or aria-describedby, and ensure tooltip content is accessible via keyboard focus to support screen reader users.
</issue_to_address>

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.

<h4>Your Project Name</h4>
<h4>Your Project Name<span class="tooltip-container ml-2">
<i class="fa fa-question-circle question-icon"></i>
<span class="tooltip-bubble">
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Consider improving tooltip accessibility for screen readers.

Use ARIA attributes like aria-label or aria-describedby, and ensure tooltip content is accessible via keyboard focus to support screen reader users.

Signed-off-by: Vedansh Saini <[email protected]>
@vedansh-5
Copy link
Contributor Author

@hpdang I have added a bubble for users to know what project name does. Does this PR make sense? Thankyou.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Project name input doesn't really work
1 participant