Add comprehensive GitHub Copilot instructions for pycomposefile development #47
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 pycomposefile codebase.What's Included
The instructions cover all essential aspects of development workflow:
Validated Development Commands:
python -m ruff check(< 1 second)python -m ruff formatpython -m unittest discover -v -s . -p "test*.py"(85 tests, < 1 second)Project Structure Documentation:
/pycomposefile/library structurecompose_file.py,__init__.py, test organization/sample/directory)Network Limitation Handling:
Manual Validation Scenarios:
CI Requirements:
.github/workflows/build.yamlrequirementsValidation
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.