Skip to content

Conversation

@patrickelectric
Copy link
Member

@patrickelectric patrickelectric commented Jan 13, 2026

Summary by Sourcery

Update internal agent guidelines and tooling preferences.

Documentation:

  • Document the preference for optional chaining in TypeScript and v-tooltip over title in Vue 2 components.
  • Add guidance to use yarn instead of npm for project commands.

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

sourcery-ai bot commented Jan 13, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates AGENTS.md contributor guidelines to prefer TypeScript optional chaining, Vue 2 v-tooltip usage, and yarn over npm in project workflows.

File-Level Changes

Change Details Files
Document new coding style preferences for TypeScript and Vue 2 components.
  • Add guideline to prefer optional chaining when possible in TypeScript code.
  • Add guideline to use v-tooltip instead of title attributes in Vue 2 components.
AGENTS.md
Document package manager preference in project workflow documentation.
  • Add a new subsection specifying that yarn should be used instead of npm.
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 found 2 issues, and left some high level feedback:

  • The guidance to 'Use optional chaining (?.) when possible in typescript' is a bit vague—consider clarifying when it should be avoided (e.g., where explicit null checks are important for logic or error handling).
  • For 'Use v-tooltip over title in vue2 components', it may help to briefly mention the reasoning (e.g., consistency, styling, accessibility) and any exceptions where title is still acceptable.
  • The new 'Use yarn over npm' section could be more actionable by specifying whether this applies to all scripts/CI tooling and, if relevant, which yarn version and lockfile strategy the project standardizes on.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The guidance to 'Use optional chaining (`?.`) when possible in typescript' is a bit vague—consider clarifying when it should be avoided (e.g., where explicit null checks are important for logic or error handling).
- For 'Use `v-tooltip` over `title` in vue2 components', it may help to briefly mention the reasoning (e.g., consistency, styling, accessibility) and any exceptions where `title` is still acceptable.
- The new 'Use yarn over npm' section could be more actionable by specifying whether this applies to all scripts/CI tooling and, if relevant, which yarn version and lockfile strategy the project standardizes on.

## Individual Comments

### Comment 1
<location> `AGENTS.md:49` </location>
<code_context>
 - No docstrings unless the function is non-obvious
 - No comments unless explaining "why", never "what"
 - Prefer editing existing files over creating new ones
+- Use optional chaining (`?.`) when possible in typescript
+- Use `v-tooltip` over `title` in vue2 components

</code_context>

<issue_to_address>
**nitpick (typo):** Capitalize "TypeScript" as a proper noun.

Please update "typescript" to "TypeScript" for correct capitalization.

```suggestion
- Use optional chaining (`?.`) when possible in TypeScript
```
</issue_to_address>

### Comment 2
<location> `AGENTS.md:81` </location>
<code_context>
 gh issue list --repo bluerobotics/BlueOS
 ```

+### 3. Use yarn over npm
+
 ## Creating a New Service
</code_context>

<issue_to_address>
**suggestion (typo):** Consider capitalizing "Yarn" as the tool name.

Also keep “npm” lowercase so both tool names match their official styling.

```suggestion
### 3. Use Yarn over npm
```
</issue_to_address>

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.

- No docstrings unless the function is non-obvious
- No comments unless explaining "why", never "what"
- Prefer editing existing files over creating new ones
- Use optional chaining (`?.`) when possible in typescript
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): Capitalize "TypeScript" as a proper noun.

Please update "typescript" to "TypeScript" for correct capitalization.

Suggested change
- Use optional chaining (`?.`) when possible in typescript
- Use optional chaining (`?.`) when possible in TypeScript

gh issue list --repo bluerobotics/BlueOS
```

### 3. Use yarn over npm
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (typo): Consider capitalizing "Yarn" as the tool name.

Also keep “npm” lowercase so both tool names match their official styling.

Suggested change
### 3. Use yarn over npm
### 3. Use Yarn over npm

@patrickelectric patrickelectric merged commit d602ecb into bluerobotics:master Jan 15, 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