Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 9, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed instructions for working effectively in the pycomposefile codebase.

What's Included

The instructions cover all essential aspects of development workflow:

Validated Development Commands:

  • Environment setup and dependency management
  • Code linting with python -m ruff check (< 1 second)
  • Code formatting with python -m ruff format
  • Test execution with python -m unittest discover -v -s . -p "test*.py" (85 tests, < 1 second)
  • Manual functionality validation using Python code snippets

Project Structure Documentation:

  • Complete overview of the /pycomposefile/ library structure
  • Key files: compose_file.py, __init__.py, test organization
  • Sample files location and purpose (/sample/ directory)

Network Limitation Handling:

  • Documents PyPI connectivity issues in sandboxed environments
  • Provides workarounds for package building failures
  • Focus on local development and testing capabilities

Manual Validation Scenarios:

from pycomposefile import ComposeFile
import yaml

compose_yaml = '''
version: '3'
services:
  web:
    image: nginx:latest
    ports:
      - '80:80'
'''
parsed = yaml.load(compose_yaml, Loader=yaml.Loader)
compose_file = ComposeFile(parsed)

CI Requirements:

  • Exact commands that must pass before committing
  • Matches .github/workflows/build.yaml requirements
  • Clear validation steps for code quality

Validation

All commands and code snippets in the instructions have been thoroughly tested and validated to work correctly in the development environment. The instructions prioritize commands that work reliably while documenting known limitations with appropriate workarounds.

Fixes #46.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: smurawski <4006985+smurawski@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨Set up Copilot instructions Add comprehensive GitHub Copilot instructions for pycomposefile development Aug 9, 2025
Copilot AI requested a review from usepowershell August 9, 2025 11:33
Copilot finished work on behalf of usepowershell August 9, 2025 11:33
@usepowershell usepowershell marked this pull request as ready for review August 13, 2025 15:44
@usepowershell usepowershell merged commit f565397 into main Aug 13, 2025
8 checks passed
@usepowershell usepowershell deleted the copilot/fix-46 branch August 13, 2025 15:44
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