Add GitHub Copilot instructions for ZnTrack repository #943
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 comprehensive GitHub Copilot coding agent instructions to help developers work effectively in the ZnTrack codebase. The instructions are stored in
.github/copilot-instructions.md
and provide detailed guidance for:Key Features
Setup and Bootstrap
uv
package managerBuild and Test Commands
Validation Scenarios
Development Workflow
Measured Timing Expectations
The instructions include actual measured times for all operations:
Validation
All instructions have been thoroughly tested and validated to ensure they work correctly for a fresh repository clone. The instructions follow the imperative tone requirement and include comprehensive coverage of the ZnTrack workflow system built on DVC.
Example validation workflow included:
Fixes #942.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
analytics.dvc.org
/home/REDACTED/work/ZnTrack/ZnTrack/.venv/bin/python /home/REDACTED/work/ZnTrack/ZnTrack/.venv/lib/python3.11/site-packages/dvc/__main__.py daemon analytics /tmp/tmpbezplzlq
(dns block)/home/REDACTED/work/ZnTrack/ZnTrack/.venv/bin/python /home/REDACTED/work/ZnTrack/ZnTrack/.venv/lib/python3.11/site-packages/dvc/__main__.py daemon analytics /tmp/tmp_jsqfqcg
(dns block)/home/REDACTED/work/ZnTrack/ZnTrack/.venv/bin/python /home/REDACTED/work/ZnTrack/ZnTrack/.venv/lib/python3.11/site-packages/dvc/__main__.py daemon analytics /tmp/tmpvfvxplke
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.