Add comprehensive GitHub Copilot instructions for Jupyter Book development workflow #382
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 GitHub Copilot with detailed guidance for working effectively in this Jupyter Book repository.What's Added
The instructions cover the complete development workflow for this QuantEcon Python Programming lecture series repository:
Environment Setup & Build Process:
conda env create -f environment.yml
)Critical Timing & Timeout Guidance:
Manual Validation Requirements:
Repository Structure & Troubleshooting:
/lectures/
,/_build/
, etc.)Validation
All commands and procedures have been thoroughly tested:
The built website displays the complete lecture series with proper navigation and styling:
The instructions follow the specified imperative tone ("Run this command", "Do not do that") and prioritize providing exact, working commands over verbose explanations. This enables GitHub Copilot to work efficiently in the codebase without trial-and-error or time-consuming searches.
Fixes #381.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
esm.ubuntu.com
/usr/lib/apt/methods/https
(dns block)fred.stlouisfed.org
/usr/share/miniconda/envs/quantecon/bin/python -Xfrozen_modules=off -m ipykernel_launcher -f /tmp/tmpatezbecg.json --HistoryManager.hist_file=:memory:
(dns block)/usr/share/miniconda/envs/quantecon/bin/python -Xfrozen_modules=off -m ipykernel_launcher -f /tmp/tmp20jfo41y.json --HistoryManager.hist_file=:memory:
(dns block)/usr/share/miniconda/envs/quantecon/bin/python -Xfrozen_modules=off -m ipykernel_launcher -f /tmp/tmp87yz_uwo.json --HistoryManager.hist_file=:memory:
(dns block)jax.quantecon.org
/usr/share/miniconda/envs/quantecon/bin/python /usr/share/miniconda/envs/quantecon/bin/jb build lectures --path-output ./ -n -W --keep-going
(dns block)/usr/share/miniconda/envs/quantecon/bin/python /usr/share/miniconda/envs/quantecon/bin/jb build lectures --builder pdflatex --path-output ./ -n -W --keep-going
(dns block)/usr/share/miniconda/envs/quantecon/bin/python /usr/share/miniconda/envs/quantecon/bin/jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter -n -W --keep-going
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.