opik: Instructions file for GitHub Copilot

.github/copilot-instructions.md

opik copilot-instructions.md is an instructions file for GitHub Copilot from comet-ml/opik. It costs 5,043 tokens per session, scanned A, original, Apache-2.0.

A set of GitHub Copilot review rules for Opik, a platform for monitoring and evaluating AI applications. It covers the project’s backend, web interface, software libraries, documentation, and tests.

In plain words
What is it for?
Reviewing pull requests across Opik’s Java backend, React and TypeScript interface, Python and TypeScript libraries, documentation, and testing code. It also guides branch names and commit messages.
Why use it?
It gives code reviews a consistent structure and explains the project’s main parts and contribution rules. This helps reviewers judge changes in the right context and follow the repository’s branch and commit conventions.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is comet-ml/opik's own configuration. It tells GitHub Copilot how to work on opik itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything opik configures →

About the project

Opik is an open-source platform for tracing, evaluating, and monitoring applications that use large language models, retrieval systems, or AI agents. Teams use it to inspect agent activity, manage prompts, run evaluations, and monitor these applications in production.

comet-ml/opik · 22,998 stars · on GitHub · comet.com

Reuse

Borrowing it

Nothing to install: this file belongs to comet-ml/opik. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/comet-ml/opik/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/comet-ml/opik

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for opik copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/comet-ml/opik/copilot-instructions/github.svg)](https://agentmods.dev/instructions/comet-ml/opik/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/comet-ml/opik/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/comet-ml/opik/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for opik copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/comet-ml/opik/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/comet-ml/opik/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 5,043 This file is loaded in full into every session.
When invoked 5,043 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.05043 $0.05043
Opus 5.5 $0.02017 $0.02017
Sonnet 5.5 $0.01009 $0.01009
Haiku 4.5 $0.00504 $0.00504

Measured 2mo ago against content hash f7c1bc10c5e5, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

opik copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 577 lines

How it starts

The opening of the file, as written. The whole thing — 577 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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

Read the full file on GitHub · 577 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 577 lines · 5,043 tokens per session scan A f7c1bc10c5e5

Subscribe to this mod's changes

opik copilot-instructions.md is an instructions file published in the GitHub repository comet-ml/opik (22,998 stars, last pushed today), licensed Apache-2.0. It adds 5,043 tokens to every session, about $0.0202 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens