Add comprehensive GitHub Copilot instructions for OpenPIV development workflow#347
Merged
Add comprehensive GitHub Copilot instructions for OpenPIV development workflow#347
Conversation
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…ands and workflows Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for OpenPIV development workflow
Aug 16, 2025
alexlib
approved these changes
Aug 16, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.mdfile that provides GitHub Copilot with detailed instructions for working effectively in the OpenPIV-python codebase.What's included
The instructions cover all essential aspects of working with OpenPIV:
Installation & Setup
poetry install~10 seconds)Testing & Validation
poetry run pytest openpiv -v~12 seconds, 198 tests pass)Workflow Examples
piv.simple_piv, validation, filtering)Repository Navigation
Validation
All commands and workflows in the instructions have been thoroughly tested:
The instructions emphasize the imperative tone ("Run this command", "NEVER CANCEL builds") and include explicit timing expectations to help Copilot work efficiently without premature timeouts.
Fixes #346.
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:
install.python-poetry.orgcurl -sSL REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.