Skip to content

Conversation

Copy link

Copilot AI commented Sep 7, 2025

This PR adds .github/copilot-instructions.md to 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:

  • Environment setup with uv venv and virtual environment activation
  • Dependency installation with proper extras ([dev], [backtest], [dev,backtest])
  • Validation pipeline with pytest, black, ruff, and mypy
  • Common issues and their solutions

Project Architecture: Detailed breakdown of:

  • Directory structure and key components
  • Main entry points (ModeAPIClient, resources, models)
  • Authentication flow and configuration
  • Pydantic model validation patterns

CI/CD Pipeline: Documentation of GitHub workflows:

  • tests.yml - Runs pytest with multiple dependency combinations
  • quality.yml - Runs code formatting, linting, and type checking
  • Validation requirements for pull requests

Quick Reference: Command cheat sheet for immediate productivity.

Validation

All instructions have been thoroughly tested in a clean environment to ensure:

  • ✅ All setup commands work correctly
  • ✅ All validation commands pass (16 tests, formatting, linting, type checking)
  • ✅ Both [dev] and [dev,backtest] installation combinations work
  • ✅ Instructions are accurate and up-to-date

This 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.

Copilot AI changed the title [WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently. You wi... Add comprehensive Copilot coding agent instructions Sep 7, 2025
Copilot AI requested a review from Danite September 7, 2025 17:39
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.

2 participants