Skip to content

Add comprehensive GitHub Copilot instructions for ollama-python development#6

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/fix-5
Draft

Add comprehensive GitHub Copilot instructions for ollama-python development#6
Copilot wants to merge 3 commits intomainfrom
copilot/fix-5

Conversation

Copy link
Copy Markdown

Copilot AI commented Aug 26, 2025

This PR creates comprehensive instructions in .github/copilot-instructions.md to guide GitHub Copilot coding agents when working in the ollama-python repository. The instructions provide exhaustive coverage of the development workflow, including setup, building, testing, and common development tasks.

Key Features

Critical Issue Documentation: The instructions identify and provide solutions for the existing indentation syntax errors in ollama/_client.py that prevent basic import functionality.

Exact Timing and Timeouts: All commands are documented with measured execution times and explicit "NEVER CANCEL" warnings with appropriate timeout values:

  • Tests: ~6 seconds (30+ second timeout recommended)
  • Build: <1 second (15+ second timeout recommended)
  • Formatting/Linting: <1 second each (15+ second timeout recommended)

Complete Development Workflow: Covers the entire development cycle using the project's uv + hatch toolchain:

# Setup
uv sync

# Development
uvx hatch fmt                    # Auto-format code
uvx hatch test                   # Run tests
uv build                         # Build package

# Validation
uvx hatch fmt --check -f         # Check formatting
uvx hatch fmt --check -l         # Check linting

Manual Validation Scenarios: Specific test scenarios for validating changes work correctly, including import tests, example execution, and build verification.

Project Structure Documentation: Comprehensive overview of the codebase organization, dependencies, and development tools to help agents navigate effectively.

Validation

All documented commands have been tested and verified to work exactly as specified. The instructions follow the imperative tone requirement ("Run this command", "Do not do this") and provide the exhaustive detail needed for reliable automation.

Fixes #5.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • astral.sh
    • Triggering command: curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 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 and others added 2 commits August 26, 2025 00:49
Co-authored-by: sealad886 <155285242+sealad886@users.noreply.github.com>
…velopment

Co-authored-by: sealad886 <155285242+sealad886@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for ollama-python development Aug 26, 2025
Copilot AI requested a review from sealad886 August 26, 2025 00: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