Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 11, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed instructions for working effectively in the Presidio codebase. The instructions were created through extensive validation of all build, test, and development workflows.

Key Features

Validated Commands with Precise Timing:

  • All build commands tested and timed (Poetry installs: Analyzer ~4 min, Anonymizer ~3.4s, CLI ~12.5s)
  • SpaCy model downloads validated (en_core_web_lg ~16s, en_core_web_sm ~4.5s)
  • Test suite execution confirmed (Analyzer ~52s with 926 tests passed, Anonymizer ~1.4s with 266 tests passed)
  • Service functionality verified with actual PII detection API calls

Critical "NEVER CANCEL" Warnings:

  • Explicit timeout recommendations (10+ minutes for builds, 5+ minutes for tests)
  • Clear guidance on expected timing to prevent premature cancellation of long-running operations

Complete Development Workflow:

  • Environment setup (Python, Poetry, dependencies)
  • Individual service build and test procedures for all 5 Presidio services
  • Service startup instructions (both individual Poetry-based and Docker compose)
  • CLI usage with working examples
  • Code quality checks with ruff linting

Manual Validation Scenarios:

  • End-to-end PII detection API testing
  • CLI functionality validation
  • Service integration testing procedures

Network Limitations Documentation:

  • Docker build issues in sandboxed environments
  • HuggingFace connectivity requirements for certain tests
  • PyPI timeout handling and retry guidance

The instructions start with a firm directive to follow the documented procedures first and only fallback to additional search when the provided information is incomplete or incorrect, ensuring consistent and reliable development workflows.

Fixes #1694.

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:

  • huggingface.co
    • Triggering command: /home/REDACTED/.cache/pypoetry/virtualenvs/presidio-analyzer-MCOD5T2k-py3.12/bin/python /home/REDACTED/.cache/pypoetry/virtualenvs/presidio-analyzer-MCOD5T2k-py3.12/bin/pytest -vv (dns block)
  • publicsuffix.org
    • Triggering command: /home/REDACTED/.cache/pypoetry/virtualenvs/presidio-analyzer-MCOD5T2k-py3.12/bin/python /home/REDACTED/.cache/pypoetry/virtualenvs/presidio-analyzer-MCOD5T2k-py3.12/bin/pytest -vv (dns block)
    • Triggering command: /home/REDACTED/.cache/pypoetry/virtualenvs/presidio-cli-3pJ939Wt-py3.12/bin/python /home/REDACTED/.cache/pypoetry/virtualenvs/presidio-cli-3pJ939Wt-py3.12/bin/presidio /tmp/test_text.txt (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.

Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for Presidio development workflow Aug 11, 2025
Copilot AI requested a review from tamirkamara August 11, 2025 05:55
Copilot finished work on behalf of tamirkamara August 11, 2025 05:55
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