Skip to content

Add comprehensive GitHub Copilot instructions for clarifai-python SDK#748

Merged
zeiler merged 3 commits intomasterfrom
copilot/fix-747
Sep 9, 2025
Merged

Add comprehensive GitHub Copilot instructions for clarifai-python SDK#748
zeiler merged 3 commits intomasterfrom
copilot/fix-747

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 18, 2025

Created a comprehensive .github/copilot-instructions.md file that provides detailed guidance for GitHub Copilot coding agents working with the Clarifai Python SDK. The instructions follow an imperative tone and prioritize validated, working commands with explicit timing and timeout recommendations.

Key Features

Development Setup Instructions:

  • Bootstrap commands with measured timing (virtual environment: 3s, pip install: 30s)
  • Both pip and uv-based workflows (CI-preferred approach)
  • Network limitation documentation and practical workarounds
  • "NEVER CANCEL" warnings with specific timeout values for long-running operations

Core Development Workflow:

  • Linting with ruff check . --fix (~0.04s)
  • Code formatting with ruff format . (~0.04s)
  • Testing scenarios and validation commands
  • Pre-commit hook setup and usage

Critical Environment Limitations:

  • Documents network connectivity issues that cause PyPI timeouts in many environments
  • Provides alternative development approaches when package installation fails
  • Includes specific error messages and troubleshooting steps

Repository Navigation Guide:

  • Key directories: clarifai/ (source), tests/ (test suite), .github/workflows/ (CI)
  • Important configuration files: .ruff.toml, pyproject.toml, requirements*.txt
  • CLI command structure and available operations

Validation Scenarios:

  • Import testing: python -c "import clarifai; print(f'Version: {clarifai.__version__}')"
  • CLI functionality verification: clarifai --help
  • Model and pipeline development workflows
  • Authentication setup with CLARIFAI_PAT environment variable

Practical Examples:

  • Complete CLI command reference with help output samples
  • Common error messages and their solutions
  • File structure listings and package information
  • Development task workflows for code changes

The instructions were validated through extensive testing of the development workflow, measuring actual command execution times, and documenting real network connectivity limitations encountered during validation.

Fixes #747.


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

Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for clarifai-python SDK Aug 18, 2025
Copilot AI requested a review from zeiler August 18, 2025 20:13
@zeiler zeiler marked this pull request as ready for review August 27, 2025 17:24
@github-actions
Copy link
Copy Markdown

Code Coverage

Package Line Rate Health
clarifai 43%
clarifai.cli 43%
clarifai.cli.templates 28%
clarifai.client 67%
clarifai.client.auth 67%
clarifai.constants 100%
clarifai.datasets 100%
clarifai.datasets.export 80%
clarifai.datasets.upload 75%
clarifai.datasets.upload.loaders 37%
clarifai.models 100%
clarifai.modules 0%
clarifai.rag 72%
clarifai.runners 52%
clarifai.runners.models 59%
clarifai.runners.pipeline_steps 45%
clarifai.runners.pipelines 80%
clarifai.runners.utils 62%
clarifai.runners.utils.data_types 72%
clarifai.schema 100%
clarifai.urls 60%
clarifai.utils 56%
clarifai.utils.evaluation 67%
clarifai.workflows 95%
Summary 62% (7733 / 12515)

Minimum allowed line rate is 50%

@zeiler zeiler merged commit a106fec into master Sep 9, 2025
16 of 23 checks passed
@zeiler zeiler deleted the copilot/fix-747 branch September 9, 2025 21:49
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