Add comprehensive Copilot coding agent instructions #3
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
.github/copilot-instructions.mdto onboard the repository for Copilot coding agents. The instructions provide comprehensive guidance to help agents work efficiently without extensive exploration.What's Included
Project Overview: Clear description of the Mode Python SDK, its purpose (trading API client), architecture, and key statistics (8 Python files, modern tooling with uv/pydantic/ruff).
Build & Development Workflow: Step-by-step instructions for:
uv venvand virtual environment activation[dev],[backtest],[dev,backtest])pytest,black,ruff, andmypyProject Architecture: Detailed breakdown of:
ModeAPIClient, resources, models)CI/CD Pipeline: Documentation of GitHub workflows:
tests.yml- Runs pytest with multiple dependency combinationsquality.yml- Runs code formatting, linting, and type checkingQuick Reference: Command cheat sheet for immediate productivity.
Validation
All instructions have been thoroughly tested in a clean environment to ensure:
[dev]and[dev,backtest]installation combinations workThis will significantly reduce the time agents spend exploring the codebase and prevent common build/validation failures, leading to higher quality pull requests.
💡 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.