python-code-reviewer

Review Python OpenInference instrumentation packages for correctness and project standards.

1.1k|289|Updated Dec 26, 2023
One-click install
npx skills add https://github.com/Arize-ai/openinference --skill python-code-reviewer-arize-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: python-code-reviewer
Source: https://github.com/Arize-ai/openinference/tree/main/.agents/skills/python-code-reviewer
Command: npx skills add https://github.com/Arize-ai/openinference --skill python-code-reviewer-arize-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the rigorous review of Python OpenInference instrumentation code, ensuring it adheres to project standards for correctness, completeness, and best practices.

Core Features & Use Cases

  • Automated Code Auditing: Checks for adherence to OpenInference's testing patterns, semantic conventions, and CI configurations.
  • Dependency Verification: Validates tox.ini, test-requirements.txt, and test setup for accurate library versioning.
  • Use Case: When submitting a Pull Request for a new OpenInference Python instrumentor, use this Skill to perform a pre-flight check, catching potential issues before human review.

Quick Start

Use the python-code-reviewer skill to audit the openinference-instrumentation-openai package.

Frequently Asked Questions about python-code-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review Python OpenInference instrumentation packages for correctness?

Reviewing Python OpenInference instrumentation packages involves validating test setup, CI configuration, semantic conventions, and span hierarchy to ensure the instrumentor meets project standards before human review.

How do I validate test setup and CI configuration for OpenInference instrumentors?

Validating test setup and CI configuration for OpenInference instrumentors requires checking dependency files like tox.ini and test-requirements.txt to verify accurate library versioning and ensure automated testing patterns are correctly configured.

What are semantic conventions and span hierarchy in Python instrumentation code?

Semantic conventions and span hierarchy in Python instrumentation code define the standardized naming and parent-child relationships for tracing spans, ensuring consistent telemetry data collection across the OpenInference ecosystem.

Can I use an automated code reviewer to pre-flight check a new OpenInference Python instrumentor pull request?

Yes, you can use an automated code reviewer to pre-flight check a new OpenInference Python instrumentor pull request, catching potential issues in testing patterns and CI configurations before human review.

Does the OpenInference code review process check for adherence to specific testing patterns?

Yes, the OpenInference code review process checks for adherence to specific testing patterns, ensuring that Python instrumentors follow project standards for correctness, completeness, and best practices across the ecosystem.

What should I check when submitting a pull request for an openinference-instrumentation-openai package?

When submitting a pull request for an openinference-instrumentation-openai package, you should check test setup, CI configuration, semantic conventions, and span hierarchy to ensure the code adheres to OpenInference project standards.