Add AI ssistants guide to follow ROS 2 project testing best practices from the workshop - #52
Merged
Merged
Conversation
…g AI assistants Signed-off-by: Xavier Ruiz <xavier.ruiz@ekumenlabs.com>
Signed-off-by: Xavier Ruiz <xavier.ruiz@ekumenlabs.com>
Signed-off-by: Xavier Ruiz <xavier.ruiz@ekumenlabs.com>
Signed-off-by: Xavier Ruiz <xavier.ruiz@ekumenlabs.com>
Signed-off-by: Xavier Ruiz <xavier.ruiz@ekumenlabs.com>
xaru8145
force-pushed
the
feature/ai_assistants
branch
from
March 16, 2026 09:01
48af49b to
c32ae77
Compare
xaru8145
changed the title
JesusSilvaUtrera
self-requested a review
March 17, 2026 10:12
JesusSilvaUtrera
approved these changes
Apr 17, 2026
JesusSilvaUtrera
left a comment
JesusSilvaUtrera
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @xaru8145! I left some comments with ideas to improve, but feel free to address them or not (I am approving to unblock you, just request another review if you address them), we can always revisit this in the future and improve the guide.
Collaborator
|
@xaru8145 when you have some time, PTAL to the comments so we can close this PR to avoid leaving it on hold for too long, thanks! |
Signed-off-by: Xavier Ruiz <xavier.ruiz@ekumenlabs.com>
JesusSilvaUtrera
approved these changes
Jul 9, 2026
JesusSilvaUtrera
left a comment
JesusSilvaUtrera
left a comment
Collaborator
There was a problem hiding this comment.
LGTM, thanks @xaru8145!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
This PR introduces an AI Best Practices Guide (
AI_TESTING_GUIDE.md) and updates the main documentation to support AI-assisted development. The goal is to provide a portable engineering standard that users can apply to their own ROS 2 projects to ensure they follow professional testing and design principles.Key changes include:
AI_TESTING_GUIDE.md: A new context file for AI assistants (Claude, GPT, Cursor) that enforces SOLID principles, the Professional Testing Pyramid, and deterministic execution (no arbitrary sleeps).README.mdUpdates: Added a prominent "AI-Ready" callout in the introduction and a detailed "AI Assistants" section at the end to guide users on how to prime their AI tools with these standards.Type
How to test
Steps to verify the new AI guidelines:
Open a new chat with an AI assistant (e.g., ChatGPT, Claude).
Provide the content of
AI_TESTING_GUIDE.mdas context.Use the example prompt from the
README: "I am developing a ROS 2 project. Act as a Senior Robotics Engineer. Before generating any code or tests, read AI_TESTING_GUIDE.md and strictly follow its guidelines...".Ask the AI to generate a simple ROS 2 node and verify it correctly separates logic into a ROS-independent C++ class.
Checklist
git commit -s) or added Signed-off-by to existing commits.Related issues
N/A