// Generate release notes for AlbumentationsX. Use when the user asks to prepare, draft, or write release notes for a new version (e.g. "prepare release notes for 2.x.y", "draft release X").
| name | release-notes |
| description | Generate release notes for AlbumentationsX. Use when the user asks to prepare, draft, or write release notes for a new version (e.g. "prepare release notes for 2.x.y", "draft release X"). |
_internal/release_notes/RELEASE_NOTES_<version>.md (e.g. RELEASE_NOTES_2.2.0.md).
git log --oneline <prev_tag>..HEAD and git show --stat <sha> per commit.git diff <prev_tag>..HEAD -- README.md for the canonical added/removed transforms list.git diff <prev_tag>..HEAD -- pyproject.toml for dependency / version bumps.## Summary — 3–5 bullet TL;DR.## Breaking changes — every backwards-incompatible change. Be specific (old → new). Include short before/after code snippets when the API surface changed.## New features — new transforms, new core features, new params on existing transforms.## Bug fixes — one entry per fix, link the PR.## Misc — CI, build, deps, internal refactors users might notice.## Commits — table of commit | PR | description for every commit since the previous tag.Match the tone of RELEASE_NOTES_2.1.2.md and RELEASE_NOTES_2.2.0.md: terse, technical, no marketing fluff, no emoji.
Every mention of a transform name in release notes MUST be a markdown link to its explore page:
[TransformName](https://albumentations.ai/explore/transform/TransformName/)
This applies to:
Commits table descriptions.The first mention in each section should be a link. Repeat mentions in the same paragraph can stay as plain backticked names if it would be visually noisy, but err on the side of always linking.
Examples (good):
### [CopyAndPaste](https://albumentations.ai/explore/transform/CopyAndPaste/) (mixing)
[CopyAndPaste](https://albumentations.ai/explore/transform/CopyAndPaste/) was mixing positional indices and `_bbox_instance_id` values...
| `Rotate.limit`, `SafeRotate.limit` | `angle_range` |
Becomes:
| [Rotate](https://albumentations.ai/explore/transform/Rotate/).limit, [SafeRotate](https://albumentations.ai/explore/transform/SafeRotate/).limit | `angle_range` |
Do not link:
Compose, BboxParams, KeypointParams, BasicTransform, BaseDistortion).angle_range, blur_range).unpack_label_wrappers, to_tuple).core/utils.py).Old | New) instead of a bullet list.pyproject.toml version isn't bumped yet, note that in the response to the user; do not bump it as part of writing the notes.Full checklist for adding a new transform to AlbumentationsX. Use when the user asks to add, implement, or create a new transform/augmentation.
Run performance benchmarks for transform changes. Use when the user asks to benchmark, measure performance, compare speed, or when changes affect apply methods, functional layer, get_params, or core pipeline code.
Quality bar for docstrings in albumentations. Use when writing or updating docstrings in albumentations/, especially for transforms and public APIs.
Use the repo `_internal/` directory for anything that must not be committed — scratch files, temporary outputs, local demos, Codex artifacts, or one-off scripts. Use when creating temp files, debug dumps, or local-only tooling during a task.
Policy for AlbumentationsX transforms that combine multiple images or objects. Use when implementing, reviewing, or using Mosaic, CopyAndPaste, OverlayElements, HistogramMatching, PixelDistributionAdaptation, or other mixing transforms.
Run the full shared Codex review checklist against a transform. Use when the user asks to review, audit, or check a transform for correctness, performance, or API consistency.