highlight feature
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
⏱️ 3m total CI duration on this PR
| Job | Cumulative Duration | Recent Runs |
|---|---|---|
| docker | 2m | 🟩 |
| pyright | 38s | 🟩 |
| Ruff | 18s | 🟩 |
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. |
|
tux/cogs/utility/highlight.py |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto 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.
This draft has been stale for >30 days now. please either finish it or close it.
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.