Add comprehensive Copilot instructions for ROCm/iris development workflow #86
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.
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides detailed guidance for GitHub Copilot agents working in the ROCm/iris codebase. The instructions were created through extensive validation and testing of the actual development workflow.Key Features
Container-First Development Approach: The instructions emphasize Docker/Apptainer containerization as the primary development method, acknowledging that ROCm/HIP toolkit installation is complex and platform-specific.
Critical Timing Warnings: All Docker operations include explicit timeout requirements (90+ minutes) with "NEVER CANCEL" warnings, based on measured build times for the >10GB ROCm/PyTorch base image.
Validated Command Reference: Every command has been tested and documented with expected outcomes, including failure scenarios for operations attempted outside the containerized environment.
Comprehensive Troubleshooting: Real error messages and solutions are provided based on actual testing, including network timeouts, missing dependencies, and GPU device access issues.
Manual Validation Scenarios: Specific testing workflows are documented for validating changes, including basic operations, atomic operations, GEMM benchmarks, and unit tests.
Contents Overview
Validation Summary
The instructions were created through comprehensive testing:
The final instructions provide 397 lines of detailed guidance that enable any GitHub Copilot agent to work effectively in the iris codebase without trial-and-error exploration.
Fixes #85.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.