Review and document robot instruction clarity issues#680
Draft
Copilot wants to merge 1 commit intomtauraso-robot-instructions-claudefrom
Draft
Review and document robot instruction clarity issues#680Copilot wants to merge 1 commit intomtauraso-robot-instructions-claudefrom
Copilot wants to merge 1 commit intomtauraso-robot-instructions-claudefrom
Conversation
Copilot
AI
changed the title
[WIP] Add comprehensive Hyrax guide for project instructions
Review and document robot instruction clarity issues
Feb 5, 2026
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
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.
Change Description
Comprehensive review of AI assistant instruction files (
HYRAX_GUIDE.md,CLAUDE.md,.github/copilot-instructions.md) identifying clarity and accuracy issues that could confuse automated agents.Solution Description
Review Findings (8 issues identified):
Major Issues:
Dataset/DataSetspelling without explaining both are intentional (line 144)hyrax.py" but they're actually standalone modules withrun()functions (line 151)__init_subclass__while verbs require@hyrax_verbdecoratorfalseConvention - "Code must treatFalseasNone" unclear whether applies to ALL boolean False or only specific optional config keysMinor Issues:
5. Missing Core Verbs - Quick reference omits
download/preparedespite being primary workflows6. Duplicated ConfigDict Explanation - Appears in both tool-specific files instead of canonical HYRAX_GUIDE.md
7. Inconsistent Timeout Guidance - Copilot instructions don't reinforce 2× timeout rule in "ALWAYS run" section
8. Undocumented HyraxImageDataset - Mixin referenced (line 214) but never introduced in Architecture section
Recommendations provided for each issue addressing terminology accuracy, documentation completeness, and reducing agent confusion.
Code Quality
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.