Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.
69
83%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
## 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 stepsWhen 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_ES.md, readme_FR.md, readme_DE.md) are AI machine-translated from the English README.md.
aae4650
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.