Create changelog files for significant changes in a pull request, a proposed code change. Describe effects users will notice and organize entries by PR number and change type, such as features or fixes.
Create changelog files for important commits in a PR
Review the instructions the agent will receive before you install.
Create changelog files for the important commits in this PR. The PR number is provided as an argument.
Skip changelog for: documentation-only, internal refactoring, test-only, CI changes, and fixes to changes that have not shipped yet (the unreleased change's entry covers them — update that entry instead if the fix alters what it should say).
First, check what commits are on the current branch compared to main:
git log main..HEAD --oneline
For each significant change, create a changelog file in the changelog/ folder using the format:
Allowed types: added, changed, deprecated, removed, fixed, security, performance, other
{PR_NUMBER}.added.md - for new features{PR_NUMBER}.added.2.md, {PR_NUMBER}.added.3.md - for additional entries of the same type{PR_NUMBER}.changed.md - for changes to existing functionality{PR_NUMBER}.fixed.md - for bug fixes{PR_NUMBER}.deprecated.md - for deprecations{PR_NUMBER}.removed.md - for removed features{PR_NUMBER}.security.md - for security fixes{PR_NUMBER}.performance.md - for performance improvements{PR_NUMBER}.other.md - for other changesEach changelog file should at least contain a main single line starting with - followed by a clear description of the change. No line wrapping.
If the change is complicated, changelog files can have indented lines after the main line with additional details or code samples.
Use ⚠️ emoji prefix for breaking changes.
Write changes in user-facing terms first. Lead with what users of the framework will notice: new APIs, changed behavior, new parameters, fixed bugs they might have hit, etc. Implementation details (internal refactoring, how something is wired up under the hood) can be included as secondary context after the user-facing description, but should never be the only content of a changelog entry when there is a user-visible effect.
Good (user-facing first, implementation detail as context):
- Turn completion instructions now persist correctly across full context updates when using `system_instruction`. Previously they were injected as a context system message, which caused warning spam and didn't survive context updates.
Bad (implementation detail only, no user-facing framing):
- Fixed turn completion instructions being injected as a context system message instead of using `system_instruction`.
Ask yourself: "If I'm a developer building on Pipecat, what would I notice changed?" Start there.
Once the entries are written, run /prose-review changelog/ and fix anything it flags.
For PR #3519 with a new feature and a bug fix:
changelog/3519.added.md:
- Added `SomeNewFeature` for doing something useful.
changelog/3519.fixed.md:
- Fixed an issue where something was not working correctly in some user-visible scenario. The root cause was an internal implementation detail.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Review and improve code changes on the current branch using Pipecat conventions. Refine names and structure, add type hints and documentation, check example patterns, and make conservative performance improvements while preserving compatibility.
Review GitHub pull requests with specialized agents that check for clear bugs and violations of project instructions in CLAUDE.md. Validate bug findings before posting focused comments on the affected lines, with fix suggestions where appropriate.
Add or improve Google-style docstrings, the explanations embedded in Python code, for modules and classes. Document constructor arguments, public methods, configuration fields, and enum values while preserving existing documentation that already meets the project’s conventions.
Draft or update GitHub pull request descriptions using the actual changes and related context. Explain the problem, changed behavior, and review concerns in plain language, including breaking changes and explicit issue-closing references when applicable.
Submit current work as a GitHub pull request, handling relevant uncommitted changes and reviewing prose before pushing. After creating the PR, run companion skills to generate changelog files, update the description, and return its URL.
Review newly added comments, docstrings, and changelog entries so future readers can understand the current code. Revise development history, redundant explanations, and unclear shorthand while preserving constraints that the code cannot explain on its own.