Onboarding brian

[woweiseng]

Summary by Sourcery

New Features:

• Add brian_onboarding_cog module registering a /todo command to display a todo list embed

[sourcery-ai]

Reviewer's Guide

Introduces a new Discord Cog for a ‘/todo’ onboarding command, implemented by defining a Cog class with logging, registering a guild-restricted slash command, constructing an embed response, and wiring it into the bot via an async setup function.

Sequence Diagram for the /todo Command Interaction

sequenceDiagram
    actor User
    participant Bot
    participant todoCog

    User->>Bot: /todo command
    Bot->>todoCog: todo(interaction)
    activate todoCog
    todoCog->>todoCog: Create discord.Embed
    todoCog-->>Bot: interaction.response.send_message(embed)
    deactivate todoCog
    Bot-->>User: Display "Todo List" Embed

Loading

Class Diagram for the New todoCog

classDiagram
    class Cog {
        <<discord.ext.commands.Cog>>
    }
    class Bot {
        <<discord.ext.commands.Bot>>
    }
    class Interaction {
        <<discord.Interaction>>
    }
    class Embed {
        <<discord.Embed>>
    }
    class Logger {
        <<logging.Logger>>
    }

    class todoCog {
      +bot: Bot
      +logger: Logger
      +__init__(bot: Bot)
      +todo(interaction: Interaction) async
    }
    todoCog --|> Cog

Loading

File-Level Changes

Change	Details	Files
Define onboarding Cog with logging	Created todoCog class inheriting from commands.Cog Initialized bot reference and cog-specific logger	src/capy_app/frontend/cogs/onboarding/brian_onboarding_cog.py
Implement guild-restricted ‘/todo’ slash command	Added @app_commands.guilds decorator for DEBUG_GUILD_ID Added @app_commands.command handler sending an embed	src/capy_app/frontend/cogs/onboarding/brian_onboarding_cog.py
Register Cog on bot startup	Defined async setup function calling bot.add_cog(todoCog)	src/capy_app/frontend/cogs/onboarding/brian_onboarding_cog.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]

Hey @woweiseng - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion: Consider making this response ephemeral

Pass ephemeral=True if the message is only for the user, to prevent channel clutter.

Suggested change

	await interaction.response.send_message(embed=embed)
	await interaction.response.send_message(embed=embed, ephemeral=True)