Skip to content

Add agent instructions and development environment guidelines - #911

Merged
jaagut merged 3 commits into
mainfrom
feature/add_agents_md
Jun 10, 2026
Merged

Add agent instructions and development environment guidelines#911
jaagut merged 3 commits into
mainfrom
feature/add_agents_md

Conversation

@jaagut

@jaagut jaagut commented Jun 10, 2026

Copy link
Copy Markdown
Member

Summary

This pull request adds comprehensive development environment instructions for agents in the new AGENTS.md file. The instructions clarify how to build, test, and format the ROS 2 workspace using Pixi, ensuring consistency with the repository's toolchain and CI.

Proposed changes

Documentation additions:

  • Added AGENTS.md with detailed guidelines for using Pixi to manage the ROS 2 workspace, including commands for building, testing, formatting, and entering the environment, as well as warnings against invoking tools directly from the host shell.

Related issues

Checklist

  • Run pixi run build
  • Write documentation
  • Test on your machine
  • Test on the robot
  • Create issues for future work
  • Triage this PR and label it

@github-project-automation github-project-automation Bot moved this to 🆕 New in Software Jun 10, 2026
@jaagut jaagut self-assigned this Jun 10, 2026
@jaagut jaagut moved this from 🆕 New to 👀 In review in Software Jun 10, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new AGENTS.md document intended to guide automated agents (and contributors) to use the repository’s Pixi-managed ROS 2 workspace consistently with CI.

Changes:

  • Added AGENTS.md describing how to build, test, and format via Pixi tasks.
  • Documented avoiding direct host-shell invocation of colcon/ROS tooling to prevent environment drift.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@jaagut
jaagut requested a review from Flova June 10, 2026 11:52
@jaagut
jaagut merged commit b054590 into main Jun 10, 2026
2 checks passed
@jaagut
jaagut deleted the feature/add_agents_md branch June 10, 2026 12:18
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Software Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

3 participants