Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 16, 2025

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

  • Primary Poetry-based development workflow (poetry install ~10 seconds)
  • Alternative installation methods (pip, conda-forge) with timing expectations
  • Build process validation (no Cython compilation currently needed)

Testing & Validation

  • Complete test suite execution (poetry run pytest openpiv -v ~12 seconds, 198 tests pass)
  • Critical validation scenarios including end-to-end PIV workflows
  • Specific timeout guidance with "NEVER CANCEL" warnings for long-running operations

Workflow Examples

  • Real PIV analysis workflows using included test data
  • API usage patterns for core functionality (piv.simple_piv, validation, filtering)
  • Tutorial execution examples with expected outputs

Repository Navigation

  • Detailed module structure and key file locations
  • CI/CD pipeline information (GitHub Actions workflows)
  • Development tools and dependencies overview

Validation

All commands and workflows in the instructions have been thoroughly tested:

# Example validated workflow
import openpiv.piv as piv
import openpiv.tools as tools
from importlib_resources import files

# Load real test images
path = files('openpiv') / 'data' / 'test1'
frame_a = tools.imread(path / 'exp1_001_a.bmp')
frame_b = tools.imread(path / 'exp1_001_b.bmp')

# Run complete PIV analysis with validation and filtering
x, y, u, v, s2n = piv.simple_piv(frame_a, frame_b)
# ... validation and filtering steps

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.org
    • Triggering command: curl -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.

@alexlib alexlib marked this pull request as ready for review August 16, 2025 19:03
@alexlib alexlib requested a review from Copilot August 16, 2025 19:03
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copilot AI requested a review from alexlib August 16, 2025 19:16
@alexlib alexlib merged commit a252fb7 into master Aug 16, 2025
3 checks passed
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