Skip to content

Review and document robot instruction clarity issues#680

Draft
Copilot wants to merge 1 commit intomtauraso-robot-instructions-claudefrom
copilot/sub-pr-679
Draft

Review and document robot instruction clarity issues#680
Copilot wants to merge 1 commit intomtauraso-robot-instructions-claudefrom
copilot/sub-pr-679

Conversation

Copy link
Contributor

Copilot AI commented Feb 5, 2026

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:

  1. Inconsistent Dataset Naming - Built-in datasets list mixes Dataset/DataSet spelling without explaining both are intentional (line 144)
  2. Verb System Terminology - Claims download/prepare/rebuild_manifest are "function-based verbs in hyrax.py" but they're actually standalone modules with run() functions (line 151)
  3. Registry Mechanism Gap - Doesn't explain why datasets auto-register via __init_subclass__ while verbs require @hyrax_verb decorator
  4. Ambiguous false Convention - "Code must treat False as None" unclear whether applies to ALL boolean False or only specific optional config keys

Minor Issues:
5. Missing Core Verbs - Quick reference omits download/prepare despite being primary workflows
6. 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

  • I have read the Contribution Guide and agree to the Code of Conduct
  • My code follows the code style of this project
  • My code builds (or compiles) cleanly without any errors or warnings
  • My code contains relevant comments and necessary documentation

💡 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.

Copilot AI changed the title [WIP] Add comprehensive Hyrax guide for project instructions Review and document robot instruction clarity issues Feb 5, 2026
Copilot AI requested a review from mtauraso February 5, 2026 21:34
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

Comments