Contributing to Opik

We're excited that you're interested in contributing to Opik! There are many ways to contribute, from writing code to improving the documentation, or even helping us with developer tooling.

How You Can Help

<CardGroup> <Card title="Report Issues & Request Features" icon="fa-regular fa-bugs" href="#submitting-a-new-issue-or-feature-request" > Help us improve by submitting bug reports and suggesting new features. </Card> <Card title="Contribute to Documentation" icon="fa-regular fa-book" href="/v1/contributing/guides/documentation"> Improve our guides, tutorials, and reference materials. </Card> <Card title="Local Development Setup" icon="fa-regular fa-laptop-code" href="/v1/contributing/guides/local-development" > Set up your local Opik development environment with Docker, local processes, or manual setup. </Card> <Card title="Contribute to Python SDK" icon="fa-brands fa-python" href="/v1/contributing/guides/python-sdk"> Enhance our Python library for Opik. </Card> <Card title="Contribute to TypeScript SDK" icon="fa-brands fa-js" href="/v1/contributing/guides/typescript-sdk"> Help improve our TypeScript library for Opik. </Card> <Card title="Contribute to Opik Agent Optimizer" icon="fa-regular fa-robot" href="/v1/contributing/guides/agent-optimizer-sdk" > Work on our agent optimization tools. </Card> <Card title="Contribute to Frontend" icon="fa-regular fa-window-maximize" href="/v1/contributing/guides/frontend"> Develop new features and UI improvements for the Opik web application. </Card> <Card title="Contribute to Backend" icon="fa-regular fa-server" href="/v1/contributing/guides/backend"> Work on the core Java services powering Opik. </Card> <Card title="Participate in Bounties" icon="fa-regular fa-gem" href="/v1/contributing/developer-programs/bounties"> The bounty program is currently paused. Check status updates here. </Card> <Card title="Spread the Word" icon="fa-regular fa-bullhorn"> Speak or write about Opik and share your experiences. Let us know on [Comet Chat](https://chat.comet.com)! </Card> </CardGroup>

Also, consider reviewing our Contributor License Agreement (CLA).

Submitting a new issue or feature request

This is a vital way to help us improve Opik!

<AccordionGroup> <Accordion title="Submitting a New Bug Report"> Before submitting a new issue, please check the [existing issues](https://github.com/comet-ml/opik/issues) to avoid duplicates.

To help us understand the issue you're experiencing, please provide:
1. Clear steps to reproduce the issue.
2. A minimal code snippet that reproduces the issue, if applicable.
This helps us diagnose the issue and fix it more quickly.

</Accordion> <Accordion title="Submitting a New Feature Request"> Feature requests are welcome! To help us understand the feature you'd like to see, please provide: 1. A short description of the motivation behind this request. 2. A detailed description of the feature you'd like to see, including any code snippets if applicable.

If you are in a position to submit a PR for the feature, feel free to open a PR!

</Accordion> </AccordionGroup>

Project Setup and Architecture

Opik is a monorepo with multiple services and SDKs. Common contributor entry points are:

apps/opik-backend: Core Java backend API/services
apps/opik-frontend: React frontend application
apps/opik-documentation: Documentation website and docs source
apps/opik-guardrails-backend, apps/opik-python-backend, apps/opik-sandbox-executor-python: supporting backends and runtime services
sdks/python, sdks/typescript, sdks/opik_optimizer: SDKs and optimizer tooling
tests_end_to_end: E2E suites and helper services

Opik relies on: ClickHouse (traces, spans, feedback), MySQL (metadata), and Redis (caching).

The local development environment uses convenient scripts (./opik.sh for Linux/Mac, .\opik.ps1 for Windows) that manage Docker Compose automatically. Please see instructions in the deployment/docker-compose/README.md on GitHub for advanced usage.

Developer Tooling & AI Assistance

To help AI assistants (like Cursor) better understand our codebase, we provide context files:

General Context: https://www.comet.com/docs/opik/llms.txt - Provides a general overview suitable for most queries.
Full Context: https://www.comet.com/docs/opik/llms-full.txt - Offers a more comprehensive context for in-depth assistance.

You can point your AI tools to these URLs to provide them with relevant information about Opik.

AI-Assisted Contributions (Required Disclosure)

AI assistance and authorship is allowed. Human authors remain fully accountable for correctness, licensing, and security.

Rules:

Always run relevant tests/linters for touched code.
Always be explicit about human/users interaction with produced output.
Always review prior issue, pull-requests and code-base for existing solutions.
Always address any system generated reviews (Baz, Greptile).
Never submit unreviewed AI output.
Never include secrets, tokens, private prompts, internal system instructions, or customer-sensitive data in generated/public content.
Never disclose vulnerabilities, exploit steps, or incident details in public issues/PRs. Use private maintainer/security channels.
You must ensure every PR include an AI disclosure watermark block in the PR description: If AI is used, include a brief ## AI Assistance note in the PR description with tool/model, scope, and confirmed human verification (if any); if no AI is used, omit that section entirely.

Review our Contributor License Agreement (CLA) if you haven't already. Comment on popular feature requests to show your support.