Skip to content

Create comprehensive GitHub Copilot instructions and fix environment.yml YAML syntax#9

Merged
mmcky merged 5 commits intomainfrom
copilot/fix-8
Aug 14, 2025
Merged

Create comprehensive GitHub Copilot instructions and fix environment.yml YAML syntax#9
mmcky merged 5 commits intomainfrom
copilot/fix-8

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 14, 2025

This PR adds a comprehensive .github/copilot-instructions.md file 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 in environment.yml.

Fixed environment.yml YAML Syntax

Corrected missing colons after name, channels, and dependencies and fixed incorrect pip section structure (was - pip followed by indented items, now properly structured as - pip:). The YAML syntax is now valid and conda env create -f environment.yml works 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

  • Environment Setup & Build Process: Environment creation takes 15 minutes (30+ minute timeout recommended), single lecture builds take 4 minutes (15+ minute timeout recommended), and full CI workflow takes 25+ minutes (45+ minute timeout recommended)
  • Comprehensive Validation & Troubleshooting: Step-by-step validation scenarios for testing changes, expected output examples for successful commands, manual verification procedures, and complete troubleshooting guide for network timeouts and build warnings
  • Repository Structure Documentation: Details of GitHub Actions workflows for Linux, macOS, and Windows testing, explanation of the 4 different lecture repositories that are tested, and key files and their purposes

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.

Copilot AI and others added 2 commits August 14, 2025 02:49
…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 AI changed the title [WIP] ✨ Set up Copilot instructions Create comprehensive GitHub Copilot instructions for QuantEcon .github repository Aug 14, 2025
Copilot AI requested a review from mmcky August 14, 2025 02:59
@mmcky
Copy link
Copy Markdown
Contributor

mmcky commented Aug 14, 2025

@copilot I have noticed you have corrected the environment.yml file. Can you suggest an update to it so you don't have to print it in the copilot-instructions?

Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 14, 2025

@copilot I have noticed you have corrected the environment.yml file. Can you suggest an update to it so you don't have to print it in the copilot-instructions?

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 conda env create -f environment.yml. Commit: ee78c24

Copilot AI changed the title Create comprehensive GitHub Copilot instructions for QuantEcon .github repository Create comprehensive GitHub Copilot instructions and fix environment.yml YAML syntax Aug 14, 2025
@mmcky
Copy link
Copy Markdown
Contributor

mmcky commented Aug 14, 2025

@copilot the versions in these instructions will get updated from time to time as environment.yml file is updated.

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>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 14, 2025

@copilot the versions in these instructions will get updated from time to time as environment.yml file is updated.

So please be aware these instructions may become out of date when we update the...

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

@mmcky mmcky marked this pull request as ready for review August 14, 2025 07:41
@mmcky mmcky merged commit ef7d5d4 into main Aug 14, 2025
@mmcky mmcky deleted the copilot/fix-8 branch August 14, 2025 07:42
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.

✨ Set up Copilot instructions

2 participants