{"owner":"comet-ml","repo":"opik","hasSkills":true,"hasMcp":false,"mcpConfig":null,"found":["AGENTS.md"],"skills":{"AGENTS.md":"# Repository Guidelines\n\n## Scope & Inheritance\n- This is the canonical monorepo guide for shared contribution policy.\n- Module-level `AGENTS.md` files should keep only module-specific guidance and reference this file for shared rules.\n\n## Project Structure & Module Organization\nThis repository is a multi-module Opik codebase. Main areas:\n- `apps/opik-backend`: Java backend (source in `src/main/java`, tests in `src/test/java`).\n- `apps/opik-frontend`: React/TypeScript frontend (`src` and related assets/config).\n- `apps/opik-documentation`: documentation website and generated API docs.\n- `sdks/python`, `sdks/typescript`, `sdks/opik_optimizer`: SDK packages and examples.\n- `deployment`, `scripts`, `extensions`: infra, tooling, and integration extension points.\n- `tests_end_to_end`, `tests_load`: cross-stack and performance test suites.\n\n## Build, Test, and Development Commands\n- `./opik.sh` — run default local stack via Docker.\n- `./opik.sh --build` — rebuild images and run the full stack.\n- `./opik.sh --verify` — run stack health checks.\n- `./opik.sh --stop` — stop local services.\n- `scripts/dev-runner.sh` — fast local process mode (BE + FE).\n- `scripts/dev-runner.sh --be-only-restart` — backend-focused local development.\n- `scripts/dev-runner.sh --build-be` / `--build-fe` — build one side only.\n- `scripts/dev-runner.sh --lint-be` — Java lint/format checks.\n- `scripts/dev-runner.sh --lint-fe` — frontend lint/type checks via `npm`.\n- `cd apps/opik-frontend && npm run lint && npm run test` — run ESLint + Vitest.\n- `cd apps/opik-frontend && npm run build` — production frontend build.\n- `cd apps/opik-backend && mvn test` — backend unit/integration tests.\n- `cd apps/opik-backend && mvn spotless:apply` — apply Java formatting.\n- `cd sdks/python && pip install -r tests/test_requirements.txt && pip install -r tests/unit/test_requirements.txt && pytest tests/unit tests/e2e` — Python SDK test suites.\n- `make precommit` — run pre-commit hooks on changed files (vs origin/main) from the root `.pre-commit-config.yaml` across all modules (do not duplicate per-module command lines in multiple places).\n- `cd sdks/typescript && npm run lint && npm run test && npm run build` — TS SDK checks.\n- `cd tests_end_to_end/e2e && npx playwright test` — cross-stack Playwright E2E suite.\n\n## Coding Style & Naming Conventions\n- Use existing module formatters/conventions and keep edits scoped; avoid blanket reformatting.\n- For detailed coding rules, defer to module-level `AGENTS.md` files and skill docs (for example `.agents/skills/python-sdk/good-code.md`) instead of duplicating style guidance here.\n\n## Testing Guidelines\n- Frameworks: Vitest (frontend + TS SDK), Playwright (frontend E2E), Maven/JUnit (backend), pytest (Python SDK).\n- Naming conventions:\n  - Java: `*Test.java` in `apps/opik-backend/src/test/java`.\n  - Python: `test_*.py` grouped under `tests/unit`, `tests/integration`, `tests/e2e`.\n  - TypeScript/JS: `*.test.ts` under `tests`.\n- Cover changed behavior with unit tests first; add integration/E2E when cross-layer behavior changes.\n- For SDK integration tests requiring external services, document any required keys in the PR.\n- For end-to-end execution across backend/frontend, use:\n  - `./opik.sh` or `scripts/dev-runner.sh` to start local services\n  - `tests_end_to_end/e2e/README.md` for suite-specific command and setup\n\n## Agent Contribution Workflow\n- This repository is a monorepo; submodule `AGENTS.md` files inherit this workflow by default.\n- Read `CONTRIBUTING.md` and `.github/pull_request_template.md` before editing or opening a PR.\n- Link tracked work in PRs with `Fixes #<id>` or `Resolves #<id>`.\n- Use GitHub CLI for PR flow and prefer draft PRs first (`gh pr create --draft`).\n- Prefer worktrees for parallel workstreams when touching multiple components.\n- Run relevant unit tests and formatters for the touched area before requesting review.\n\n## Commit & Pull Request Guidelines\n- PR title and first commit should use semantic style with ticket prefix: `[OPIK-1234] [COMPONENT] feat|fix|refactor|docs: short summary`.\n- Follow existing component prefixes (`[FE]`, `[SDK]`, `[DOCS]`, `[NA]`, `[INFRA]`, etc.).\n- PR descriptions should include: change summary, test coverage run, and linked issue references (`Resolves #...`).\n- Follow `pull_request_template.md` sections: Details, checklist, Issues, Testing, Documentation.\n- Include screenshots or short recordings for user-visible UI changes when possible.\n\n## Ignored Surfaces\n- `.github/instructions/` contains GitHub Copilot-specific instruction files. Other agents should ignore this directory and use `.agents/` as the canonical source.\n- `.github/copilot-instructions.md` is GitHub Copilot code review guidance only.\n\n## Security & Configuration Tips\n- Keep secrets and API keys out of source control; use local `.env` or shell variables.\n- For local self-hosted testing, ensure dependencies are configured (MySQL, ClickHouse, Redis) before running backend tests.\n- Prefer `opik configure --use_local` when running SDK examples against your local deployment.\n\n## Generated Files\n- `apps/opik-backend/src/main/resources/model_prices_and_context_window.json` and `apps/opik-frontend/src/data/model_prices_and_context_window.json` are generated artifacts.\n- Do not edit these files directly; updates should come from the repository updater automation.\n"},"files":{"AGENTS.md":"# Repository Guidelines\n\n## Scope & Inheritance\n- This is the canonical monorepo guide for shared contribution policy.\n- Module-level `AGENTS.md` files should keep only module-specific guidance and reference this file for shared rules.\n\n## Project Structure & Module Organization\nThis repository is a multi-module Opik codebase. Main areas:\n- `apps/opik-backend`: Java backend (source in `src/main/java`, tests in `src/test/java`).\n- `apps/opik-frontend`: React/TypeScript frontend (`src` and related assets/config).\n- `apps/opik-documentation`: documentation website and generated API docs.\n- `sdks/python`, `sdks/typescript`, `sdks/opik_optimizer`: SDK packages and examples.\n- `deployment`, `scripts`, `extensions`: infra, tooling, and integration extension points.\n- `tests_end_to_end`, `tests_load`: cross-stack and performance test suites.\n\n## Build, Test, and Development Commands\n- `./opik.sh` — run default local stack via Docker.\n- `./opik.sh --build` — rebuild images and run the full stack.\n- `./opik.sh --verify` — run stack health checks.\n- `./opik.sh --stop` — stop local services.\n- `scripts/dev-runner.sh` — fast local process mode (BE + FE).\n- `scripts/dev-runner.sh --be-only-restart` — backend-focused local development.\n- `scripts/dev-runner.sh --build-be` / `--build-fe` — build one side only.\n- `scripts/dev-runner.sh --lint-be` — Java lint/format checks.\n- `scripts/dev-runner.sh --lint-fe` — frontend lint/type checks via `npm`.\n- `cd apps/opik-frontend && npm run lint && npm run test` — run ESLint + Vitest.\n- `cd apps/opik-frontend && npm run build` — production frontend build.\n- `cd apps/opik-backend && mvn test` — backend unit/integration tests.\n- `cd apps/opik-backend && mvn spotless:apply` — apply Java formatting.\n- `cd sdks/python && pip install -r tests/test_requirements.txt && pip install -r tests/unit/test_requirements.txt && pytest tests/unit tests/e2e` — Python SDK test suites.\n- `make precommit` — run pre-commit hooks on changed files (vs origin/main) from the root `.pre-commit-config.yaml` across all modules (do not duplicate per-module command lines in multiple places).\n- `cd sdks/typescript && npm run lint && npm run test && npm run build` — TS SDK checks.\n- `cd tests_end_to_end/e2e && npx playwright test` — cross-stack Playwright E2E suite.\n\n## Coding Style & Naming Conventions\n- Use existing module formatters/conventions and keep edits scoped; avoid blanket reformatting.\n- For detailed coding rules, defer to module-level `AGENTS.md` files and skill docs (for example `.agents/skills/python-sdk/good-code.md`) instead of duplicating style guidance here.\n\n## Testing Guidelines\n- Frameworks: Vitest (frontend + TS SDK), Playwright (frontend E2E), Maven/JUnit (backend), pytest (Python SDK).\n- Naming conventions:\n  - Java: `*Test.java` in `apps/opik-backend/src/test/java`.\n  - Python: `test_*.py` grouped under `tests/unit`, `tests/integration`, `tests/e2e`.\n  - TypeScript/JS: `*.test.ts` under `tests`.\n- Cover changed behavior with unit tests first; add integration/E2E when cross-layer behavior changes.\n- For SDK integration tests requiring external services, document any required keys in the PR.\n- For end-to-end execution across backend/frontend, use:\n  - `./opik.sh` or `scripts/dev-runner.sh` to start local services\n  - `tests_end_to_end/e2e/README.md` for suite-specific command and setup\n\n## Agent Contribution Workflow\n- This repository is a monorepo; submodule `AGENTS.md` files inherit this workflow by default.\n- Read `CONTRIBUTING.md` and `.github/pull_request_template.md` before editing or opening a PR.\n- Link tracked work in PRs with `Fixes #<id>` or `Resolves #<id>`.\n- Use GitHub CLI for PR flow and prefer draft PRs first (`gh pr create --draft`).\n- Prefer worktrees for parallel workstreams when touching multiple components.\n- Run relevant unit tests and formatters for the touched area before requesting review.\n\n## Commit & Pull Request Guidelines\n- PR title and first commit should use semantic style with ticket prefix: `[OPIK-1234] [COMPONENT] feat|fix|refactor|docs: short summary`.\n- Follow existing component prefixes (`[FE]`, `[SDK]`, `[DOCS]`, `[NA]`, `[INFRA]`, etc.).\n- PR descriptions should include: change summary, test coverage run, and linked issue references (`Resolves #...`).\n- Follow `pull_request_template.md` sections: Details, checklist, Issues, Testing, Documentation.\n- Include screenshots or short recordings for user-visible UI changes when possible.\n\n## Ignored Surfaces\n- `.github/instructions/` contains GitHub Copilot-specific instruction files. Other agents should ignore this directory and use `.agents/` as the canonical source.\n- `.github/copilot-instructions.md` is GitHub Copilot code review guidance only.\n\n## Security & Configuration Tips\n- Keep secrets and API keys out of source control; use local `.env` or shell variables.\n- For local self-hosted testing, ensure dependencies are configured (MySQL, ClickHouse, Redis) before running backend tests.\n- Prefer `opik configure --use_local` when running SDK examples against your local deployment.\n\n## Generated Files\n- `apps/opik-backend/src/main/resources/model_prices_and_context_window.json` and `apps/opik-frontend/src/data/model_prices_and_context_window.json` are generated artifacts.\n- Do not edit these files directly; updates should come from the repository updater automation.\n"},"items":[{"name":"AGENTS.md","path":"AGENTS.md","title":"AGENTS.md","content":"# Repository Guidelines\n\n## Scope & Inheritance\n- This is the canonical monorepo guide for shared contribution policy.\n- Module-level `AGENTS.md` files should keep only module-specific guidance and reference this file for shared rules.\n\n## Project Structure & Module Organization\nThis repository is a multi-module Opik codebase. Main areas:\n- `apps/opik-backend`: Java backend (source in `src/main/java`, tests in `src/test/java`).\n- `apps/opik-frontend`: React/TypeScript frontend (`src` and related assets/config).\n- `apps/opik-documentation`: documentation website and generated API docs.\n- `sdks/python`, `sdks/typescript`, `sdks/opik_optimizer`: SDK packages and examples.\n- `deployment`, `scripts`, `extensions`: infra, tooling, and integration extension points.\n- `tests_end_to_end`, `tests_load`: cross-stack and performance test suites.\n\n## Build, Test, and Development Commands\n- `./opik.sh` — run default local stack via Docker.\n- `./opik.sh --build` — rebuild images and run the full stack.\n- `./opik.sh --verify` — run stack health checks.\n- `./opik.sh --stop` — stop local services.\n- `scripts/dev-runner.sh` — fast local process mode (BE + FE).\n- `scripts/dev-runner.sh --be-only-restart` — backend-focused local development.\n- `scripts/dev-runner.sh --build-be` / `--build-fe` — build one side only.\n- `scripts/dev-runner.sh --lint-be` — Java lint/format checks.\n- `scripts/dev-runner.sh --lint-fe` — frontend lint/type checks via `npm`.\n- `cd apps/opik-frontend && npm run lint && npm run test` — run ESLint + Vitest.\n- `cd apps/opik-frontend && npm run build` — production frontend build.\n- `cd apps/opik-backend && mvn test` — backend unit/integration tests.\n- `cd apps/opik-backend && mvn spotless:apply` — apply Java formatting.\n- `cd sdks/python && pip install -r tests/test_requirements.txt && pip install -r tests/unit/test_requirements.txt && pytest tests/unit tests/e2e` — Python SDK test suites.\n- `make precommit` — run pre-commit hooks on changed files (vs origin/main) from the root `.pre-commit-config.yaml` across all modules (do not duplicate per-module command lines in multiple places).\n- `cd sdks/typescript && npm run lint && npm run test && npm run build` — TS SDK checks.\n- `cd tests_end_to_end/e2e && npx playwright test` — cross-stack Playwright E2E suite.\n\n## Coding Style & Naming Conventions\n- Use existing module formatters/conventions and keep edits scoped; avoid blanket reformatting.\n- For detailed coding rules, defer to module-level `AGENTS.md` files and skill docs (for example `.agents/skills/python-sdk/good-code.md`) instead of duplicating style guidance here.\n\n## Testing Guidelines\n- Frameworks: Vitest (frontend + TS SDK), Playwright (frontend E2E), Maven/JUnit (backend), pytest (Python SDK).\n- Naming conventions:\n  - Java: `*Test.java` in `apps/opik-backend/src/test/java`.\n  - Python: `test_*.py` grouped under `tests/unit`, `tests/integration`, `tests/e2e`.\n  - TypeScript/JS: `*.test.ts` under `tests`.\n- Cover changed behavior with unit tests first; add integration/E2E when cross-layer behavior changes.\n- For SDK integration tests requiring external services, document any required keys in the PR.\n- For end-to-end execution across backend/frontend, use:\n  - `./opik.sh` or `scripts/dev-runner.sh` to start local services\n  - `tests_end_to_end/e2e/README.md` for suite-specific command and setup\n\n## Agent Contribution Workflow\n- This repository is a monorepo; submodule `AGENTS.md` files inherit this workflow by default.\n- Read `CONTRIBUTING.md` and `.github/pull_request_template.md` before editing or opening a PR.\n- Link tracked work in PRs with `Fixes #<id>` or `Resolves #<id>`.\n- Use GitHub CLI for PR flow and prefer draft PRs first (`gh pr create --draft`).\n- Prefer worktrees for parallel workstreams when touching multiple components.\n- Run relevant unit tests and formatters for the touched area before requesting review.\n\n## Commit & Pull Request Guidelines\n- PR title and first commit should use semantic style with ticket prefix: `[OPIK-1234] [COMPONENT] feat|fix|refactor|docs: short summary`.\n- Follow existing component prefixes (`[FE]`, `[SDK]`, `[DOCS]`, `[NA]`, `[INFRA]`, etc.).\n- PR descriptions should include: change summary, test coverage run, and linked issue references (`Resolves #...`).\n- Follow `pull_request_template.md` sections: Details, checklist, Issues, Testing, Documentation.\n- Include screenshots or short recordings for user-visible UI changes when possible.\n\n## Ignored Surfaces\n- `.github/instructions/` contains GitHub Copilot-specific instruction files. Other agents should ignore this directory and use `.agents/` as the canonical source.\n- `.github/copilot-instructions.md` is GitHub Copilot code review guidance only.\n\n## Security & Configuration Tips\n- Keep secrets and API keys out of source control; use local `.env` or shell variables.\n- For local self-hosted testing, ensure dependencies are configured (MySQL, ClickHouse, Redis) before running backend tests.\n- Prefer `opik configure --use_local` when running SDK examples against your local deployment.\n\n## Generated Files\n- `apps/opik-backend/src/main/resources/model_prices_and_context_window.json` and `apps/opik-frontend/src/data/model_prices_and_context_window.json` are generated artifacts.\n- Do not edit these files directly; updates should come from the repository updater automation.\n","category":"root","tokens":1342}]}