Skip to content

Conversation

@patrickelectric
Copy link
Member

@patrickelectric patrickelectric commented Jan 10, 2026

Summary by Sourcery

Documentation:

  • Document BlueOS AI agent persona, project context, workflows, and critical development rules in AGENTS.md.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 10, 2026

Reviewer's Guide

Introduces AGENTS.md, a high-level instruction document defining how AI agents should behave and work within the BlueOS repository, including persona, project context, development conventions, and critical rules for dependencies, services, and code quality.

Flow diagram for creating a new BlueOS service (flow diagram)

flowchart TD
    A[Start: Need a new service] --> B[Define service purpose in one sentence]
    B --> C[Identify most similar existing service
copy its structure]
    C --> D[Check core/tools/nginx/nginx.conf
select unused port]
    D --> E[Check core/pyproject.toml
use existing dependencies only]
    E --> F[Implement service inside core/services
following existing patterns]
    F --> G[Register service in core/pyproject.toml]
    G --> H[Register service in start-blueos-core]
    H --> I[Update core/tools/nginx/nginx.conf
with new route]
    I --> J[Run .hooks/pre-push --fix]
    J --> K[All checks pass?]
    K -->|No| F
    K -->|Yes| L[Open PR for review]
    L --> M[End]
Loading

File-Level Changes

Change Details Files
Add AGENTS.md as a BlueOS-specific guide for AI agents contributing to the repository.
  • Define the expected AI agent persona focusing on BlueOS backend development and relevant technologies.
  • Document BlueOS project context, architecture, directory structure, and key reference files for navigation.
  • Specify strict output and coding requirements, including style, line length, and preferences for editing existing files.
  • Lay out critical rules for dependency usage, GitHub CLI usage, and creating new services based on an existing reference PR.
  • Describe required code quality checks and common pitfalls related to async patterns, dependencies, and service registration.
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:

  • The fixed dependency version list in 'Critical Rules' may drift from core/pyproject.toml over time; consider instead pointing explicitly to that file as the single source of truth rather than duplicating the versions here.
  • Some guidance (e.g., using gh, running ./.hooks/pre-push) is generally applicable to contributors beyond AI agents; consider clarifying the intended audience at the top or factoring shared contributor guidance into a common location to avoid divergence.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The fixed dependency version list in 'Critical Rules' may drift from core/pyproject.toml over time; consider instead pointing explicitly to that file as the single source of truth rather than duplicating the versions here.
- Some guidance (e.g., using gh, running ./.hooks/pre-push) is generally applicable to contributors beyond AI agents; consider clarifying the intended audience at the top or factoring shared contributor guidance into a common location to avoid divergence.

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 force-pushed the agents-md branch 2 times, most recently from 4f579bd to 4fb8291 Compare January 12, 2026 15:20
Signed-off-by: Patrick José Pereira <[email protected]>
@joaomariolago joaomariolago merged commit 6266300 into bluerobotics:master Jan 12, 2026
6 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