Skip to content

highlight feature #839

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

highlight feature #839

wants to merge 1 commit into from

Conversation

amyulating
Copy link
Contributor

@amyulating amyulating commented Apr 23, 2025

PR to add highlights

things that need to be done:

  • integration with the DB
  • a pretty embed for the response

Summary by Sourcery

Add a highlight feature to the Discord bot that allows users to be notified when specific keywords are mentioned in a server

New Features:

  • Implement a highlight system where users can add and remove keywords to be notified about when mentioned in a server

Enhancements:

  • Create a mechanism to send direct messages to users when their specified keywords are mentioned in a channel

Copy link

trunk-io bot commented Apr 23, 2025

⏱️ 3m total CI duration on this PR

Job Cumulative Duration Recent Runs
docker 2m 🟩
pyright 38s 🟩
Ruff 18s 🟩

settingsfeedbackdocs ⋅ learn more about trunk.io

Copy link
Contributor

sourcery-ai bot commented Apr 23, 2025

Reviewer's Guide by Sourcery

This pull request introduces a basic highlight feature. The bot listens to messages and DMs the user if a keyword they set is mentioned. A command is included to manage these keywords.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Implements a basic highlight feature that sends a DM to a user when a keyword they have set is mentioned in a channel.
  • Adds a cog called Highlight.
  • Adds an on_message listener that checks if a message contains a keyword that a user has set.
  • Adds a highlight command that allows a user to add or remove keywords to their highlight list.
tux/cogs/utility/highlight.py

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

@amyulating amyulating changed the title skeleton for highlight highlight feature Apr 23, 2025
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