opik copilot-instructions.md

Copilot Code Review Instructions

Scope: These guidelines apply to all Opik applications including backend, frontend, and SDKs. Use the appropriate sections based on the code being reviewed.

When Copilot automatically reviews pull requests, use the following guidelines to structure feedback and ensure consistency across the entire Opik project.

---

Project Overview

Opik is a comprehensive observability and AI evaluation platform with multiple applications:

• Backend: Java-based REST API with MySQL and ClickHouse databases
• Frontend: React/TypeScript application with modern UI components
• Python SDK: Client library for Python applications
• TypeScript SDK: Client library for TypeScript/JavaScript applications
• Documentation: Comprehensive documentation site
• Testing: End-to-end and load testing suites

1. Git Workflow & Branch Management

Branch Naming Convention

{username}/{ticket}-{summary}

Examples:

andrescrz/OPIK-2236-add-documentation-and-user-facing-distinction-to-pr-template
someuser/issue-1234-some-task
someotheruser/NA-some-other-task

Commit Message Standards

Use component types to categorize changes (optional but recommended):

• [DOCS] - Documentation updates, README changes, comments, swagger/OpenAPI documentation
• [FE] - Frontend changes (React, TypeScript, UI components)
• [BE] - Backend changes (Java, API endpoints, services)
• [SDK] - SDK changes (Python, TypeScript SDKs)

Examples:

# ✅ Recommended format
git commit -m "[OPIK-1234] [FE] Add project custom metrics UI dashboard"
git commit -m "[OPIK-1234] [BE] Add create trace endpoint"

# ✅ Also acceptable
git commit -m "[OPIK-1234] Add project custom metrics UI dashboard"

Pull Request Guidelines

Title Format: [{ticket}] [{component}] {summary}

Required Sections:

• Details: What the change does, why it was made, and any design decisions
• Change checklist: User facing and Documentation update checkboxes
• Issues: GitHub issue or Jira ticket references
• Testing: Scenarios covered by tests and steps to reproduce
• Documentation: List of docs updated or new configuration introduced