Skip to content

Conversation

@patrickelectric
Copy link
Member

@patrickelectric patrickelectric commented Jan 20, 2026

Summary by Sourcery

Update agent guidelines to better cover frontend development practices and clarify the developer persona.

Documentation:

  • Clarify the developer persona to include both backend and frontend (TypeScript, Vue 2 with Vuetify).

Chores:

  • Document common frontend pitfalls and best practices alongside existing backend guidelines.

…ot only backend

Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
@sourcery-ai
Copy link

sourcery-ai bot commented Jan 20, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the AGENTS persona and common pitfalls documentation to better reflect full-stack (frontend and backend) responsibilities, including more precise frontend tech stack details and new frontend-specific pitfalls.

Flow diagram for updated backend and frontend pitfalls documentation

flowchart TD
    A[AGENTS_persona] --> B[Responsibilities]
    B --> C[Backend_focus]
    B --> D[Frontend_focus]

    subgraph Backend_pitfalls
        C1[Check_existing_dependencies_in_pyproject_toml]
        C2[Reuse_aiohttp_sessions_or_use_context_managers]
        C3[Register_service_in_pyproject_toml_start_blueos_core_and_nginx_conf]
        C4[Avoid_blocking_IO_use_async_versions]
        C5[Use_versioned_api_route_1_0_for_API_versioning]
    end

    subgraph Frontend_pitfalls
        D1[Use_Vuetify_theme_colors_primary_success_etc]
        D2[Keep_one_component_per_vue_file]
        D3[Clear_intervals_and_timeouts_in_beforeDestroy_and_use_OneMoreTime]
        D4[Prefer_object_destructuring_over_direct_property_access]
    end

    C --> Backend_pitfalls
    D --> Frontend_pitfalls
Loading

File-Level Changes

Change Details Files
Broaden persona description and refine frontend tech stack wording.
  • Change persona from backend-only to general BlueOS developer role.
  • Correct capitalization and spacing for TypeScript.
  • Clarify Vue stack as Vue 2 with Vuetify.
AGENTS.md
Document common frontend pitfalls alongside existing backend pitfalls.
  • Introduce a Backend subsection heading for existing pitfalls to distinguish them from frontend ones.
  • Add a Frontend subsection with guidelines on Vuetify theme color usage, component-per-file structure, cleanup of timers, and use of object destructuring.
AGENTS.md

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

Copy link

@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 - I've left some high level feedback:

  • In the frontend pitfalls section, the guidance on 'Direct property access' is a bit vague—consider clarifying when and why destructuring is preferred (and when direct access is acceptable), ideally with a brief example.
  • The reference to OneMoreTime in the frontend cleanup pitfall might be unclear to readers unfamiliar with it—adding a short description or context for what it is and when to use it would improve the guideline.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the frontend pitfalls section, the guidance on 'Direct property access' is a bit vague—consider clarifying when and why destructuring is preferred (and when direct access is acceptable), ideally with a brief example.
- The reference to `OneMoreTime` in the frontend cleanup pitfall might be unclear to readers unfamiliar with it—adding a short description or context for what it is and when to use it would improve the guideline.

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.

@patrickelectric patrickelectric merged commit 80f46fc into bluerobotics:master Jan 20, 2026
7 checks passed
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.

2 participants