tux icon indicating copy to clipboard operation
tux copied to clipboard

highlight feature

Open amyulating opened this issue 8 months ago • 2 comments

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

amyulating avatar Apr 23 '25 16:04 amyulating

⏱️ 3m total CI duration on this PR

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

settingsfeedbackdocs ⋅ learn more about trunk.io

trunk-io[bot] avatar Apr 23 '25 16:04 trunk-io[bot]

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

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Apr 23 '25 16:04 sourcery-ai[bot]

This draft has been stale for >30 days now. please either finish it or close it.

anemoijereja-eden avatar Jun 20 '25 17:06 anemoijereja-eden

due to inactivity I am going to be closing this draft pull. Feel free to reopen down the line if you would like to continue development.

anemoijereja-eden avatar Jun 23 '25 00:06 anemoijereja-eden