Create comprehensive GitHub Copilot instructions and fix environment.yml YAML syntax#9
Create comprehensive GitHub Copilot instructions and fix environment.yml YAML syntax#9
Conversation
…ment setup Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
…and timing Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
|
@copilot I have noticed you have corrected the |
Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
I've updated the environment.yml file to fix the YAML syntax errors (missing colons and incorrect pip section structure) and simplified the copilot-instructions.md to reference the now-working environment.yml directly instead of including an inline corrected version. The environment.yml now has proper YAML syntax and can be used directly with |
|
@copilot the versions in these instructions will get updated from time to time as So please be aware these instructions may become out of date when we update the environment file. |
…ter maintainability Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
You're absolutely right. I've updated the copilot-instructions.md to remove hardcoded version numbers and make them version-agnostic. The instructions now reference "Jupyter Book version information" instead of specific versions, and the expected output examples use placeholder formats (like "1.0.x.postX") instead of exact version numbers. This will keep the instructions accurate as the environment.yml file gets updated over time. Commit: 7bfcfd6 |
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions on how to work effectively with the QuantEcon/.github repository, and fixes critical YAML syntax errors inenvironment.yml.Fixed environment.yml YAML Syntax
Corrected missing colons after
name,channels, anddependenciesand fixed incorrect pip section structure (was- pipfollowed by indented items, now properly structured as- pip:). The YAML syntax is now valid andconda env create -f environment.ymlworks directly.Comprehensive Copilot Instructions
The instructions document the correct conda environment setup process with timing expectations (15+ minutes), include validated commands for building Jupyter Book lecture repositories (~4 minutes each), and provide complete CI workflow simulation commands with critical timing information. All commands include "NEVER CANCEL" warnings with specific timeout recommendations.
Version-Agnostic Design: The instructions avoid hardcoded version numbers and instead reference version information generically (e.g., "Jupyter Book version information" rather than specific versions). This ensures the instructions remain accurate as the environment.yml file is updated over time.
Key Documentation Areas
The instructions follow an imperative tone and start with a firm directive to always follow the provided instructions first before searching for additional context. All commands have been validated through actual testing during development.
Fixes #8.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.