Menu
Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | documentation |
| description | Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases. |
## Summary
- What this PR does (bullet points)
## Test Plan
- How to verify it works
## Related Issues
- Resolves #123
### [VERSION] - [DATE]
#### New Features
- **Feature Name**: Brief description
#### Improvements
- **Improvement**: What changed and why
#### Bug Fixes
- **Fix**: What was broken (#issue)
#### Breaking Changes
- **Change**: What breaks, migration steps
When documenting a feature, cover:
User Impact
Technical Changes
Breaking Changes (if any)
CHANGELOG.md - Self-hosted deployment changelog (breaking/critical changes only)apps/opik-documentation/documentation/fern/docs/changelog/ - Main product docs changelog entries (dated .mdx files)apps/opik-documentation/documentation/fern/docs/agent_optimization/getting_started/changelog.mdx - Agent Optimizer release changelogapps/opik-documentation/documentation/fern/docs.yml - Docs routing/navigation source of truth for changelog surfaces.github/release-drafter.yml - Release templateCHANGELOG.md.CHANGELOG.md only for self-hosted deployment breaking/critical/security-impacting notes.apps/opik-documentation/documentation/fern/docs/changelog/*.mdx for general Opik product release notes shown in /docs/opik/changelog.apps/opik-documentation/documentation/fern/docs/agent_optimization/getting_started/changelog.mdx for Agent Optimizer version updates (for example sdks/opik_optimizer releases like 3.1.0).changelog.xml files are migration manifests, not user-facing release-note changelogs.apps/opik-documentation/documentation/fern/docs.yml before editing.fern/img for documentation images (e.g. apps/opik-documentation/documentation/fern/img/...).static/img for new assets; it is a legacy folder used by external integrations and cannot be deleted./img/... (e.g. /img/tracing/openai_integration.png).docs.yaml/docs.yml, treat that file as the routing source of truth; do not assume URLs mirror directory layout.Non-English README files (readme_CN.md, readme_JP.md, readme_KO.md, readme_PT_BR.md) are AI machine-translated from the English README.md.
Use when a developer wants to add, write, or create an end-to-end test for an Opik feature, page, or branch โ e.g. "add an e2e test for the experiments comparison page", "write a test for the feature I just built", "e2e test for this branch", "cover the dataset items flow with a test". Runs the full loop in tests_end_to_end/e2e/ โ analyze the feature and frontend code, explore the live UI with the Playwright MCP, write the Page Object Model + spec, and run it locally until green.
Use when an Opik E2E test has failed and a developer wants it investigated โ e.g. "why did this e2e test fail?", "investigate the failing run on my PR", "is dataset-crud-smoke flaky?", "the nightly e2e suite went red". Takes a failure from a CI check, a TestOps launch, a test name, or a local run; gathers the trace and history, classifies regression vs. flake, and proposes a fix. Read-only โ it diagnoses and proposes, it does not edit tests.
Use when building or extending a Page Object Model (POM) for the Opik E2E suite (under `tests_end_to_end/e2e/pom/`) and you need to choose stable selectors against the live UI. Walks through seeding required state, exploring the running page with the Playwright MCP (accessibility snapshot + data-testid enumeration), picking the most stable locator for each element, and verifying it before committing. Used as the discovery sub-step by the `writing-e2e-tests` skill.
Java backend patterns for Opik. Use when working in apps/opik-backend, designing APIs, database operations, or services.
React frontend patterns for Opik. Use when working in apps/opik-frontend, on components, state, or data fetching.
Python SDK patterns for Opik. Use when working in sdks/python, on SDK APIs, integrations, or message processing.